Bump gem version to v1.0.0

Author: grzuy

CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## [v1.0.0] - 2020-07-08
+
+### Added
+
+- ECDSA with **secp256k1** curve support added:
+  ```rb
+  OpenSSL::SignatureAlgorithm::ECDSA.new(curve: "secp256k1")
+  ```
+- Algorithm **arguments** are now **optional**. The following works:
+
+  ```rb
+  OpenSSL::SignatureAlgorithm::ECDSA.new
+  # defaults to ECDSA with SHA-256 and NIST P256 curve
+  # Same as OpenSSL::SignatureAlgorithm::ECDSA.new(hash_function: "SHA256", curve: "prime256v1")
+
+  OpenSSL::SignatureAlgorithm::RSAPSS.new
+  # defaults to SHA-256
+  # Same as OpenSSL::SignatureAlgorithm::RSAPSS.new(hash_function: "SHA256")
+
+  OpenSSL::SignatureAlgorithm::RSAPKCS1.new
+  # defaults to SHA-256
+  # Same as OpenSSL::SignatureAlgorithm::RSAPSS.new(hash_function: "SHA256")
+  ```
+
+### Changed
+
+- Algorithm **instantiation** changed. The positional argument `digest_length` is replaced with keyword arguments, `hash_function:` for RSA algorithms and `hash_function:` and `curve:` for ECDSA. None are required arguments, you get sane defaults if you don't provide any arguments. Code migration examples:
+  ```rb
+  # Change this
+  # OpenSSL::SignatureAlgorithm::ECDSA.new("256")
+  # to
+  OpenSSL::SignatureAlgorithm::ECDSA.new(hash_function: "SHA256")
+  ```
+  ```rb
+  # Change this
+  # OpenSSL::SignatureAlgorithm::RSAPSS.new("384")
+  # to
+  OpenSSL::SignatureAlgorithm::RSAPSS.new(hash_function: "SHA384")
+  ```
+
 ## [v0.4.0] - 2020-01-31
 
 ### Added
@@ -32,6 +72,7 @@
 - `OpenSSL::SignatureAlgorithm::RSAPSS`
 - `OpenSSL::SignatureAlgorithm::RSAPKCS1`
 
+[v1.0.0]: https://github.com/cedarcode/openssl-signature_algorithm/compare/v0.4.0...v1.0.0/
 [v0.4.0]: https://github.com/cedarcode/openssl-signature_algorithm/compare/v0.3.0...v0.4.0/
 [v0.3.0]: https://github.com/cedarcode/openssl-signature_algorithm/compare/v0.2.0...v0.3.0/
 [v0.2.0]: https://github.com/cedarcode/openssl-signature_algorithm/compare/v0.1.1...v0.2.0/

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openssl-signature_algorithm (0.4.0)
+    openssl-signature_algorithm (1.0.0)
 
 GEM
   remote: https://rubygems.org/

README.md

@@ -1,9 +1,13 @@
 # OpenSSL::SignatureAlgorithm
 
+> ECDSA, RSA-PSS and RSA-PKCS#1 signature algorithms for ruby
+
+Sign and verify using signature algorithm wrappers, instead of key objects.
+
 Provides `OpenSSL::SignatureAlgorithm::ECDSA`, `OpenSSL::SignatureAlgorithm::RSAPSS`
 and `OpenSSL::SignatureAlgorithm::RSAPKCS1` ruby object wrappers on top of `OpenSSL::PKey::EC`
-and `OpenSSL::PKey::RSA`, so that you can reason in terms of signature algorithms when
-signing and/or verifying signatures, instead of keys.
+and `OpenSSL::PKey::RSA`, so that you can reason in terms of the algorithms and do less when
+signing or verifying signatures.
 
 [![Gem](https://img.shields.io/gem/v/openssl-signature_algorithm.svg?style=flat-square&color=informational)](https://rubygems.org/gems/openssl-signature_algorithm)
 [![Travis](https://img.shields.io/travis/cedarcode/openssl-signature_algorithm/master.svg?style=flat-square)](https://travis-ci.org/cedarcode/openssl-signature_algorithm)

lib/openssl/signature_algorithm/version.rb

@@ -2,6 +2,6 @@
 
 module OpenSSL
   module SignatureAlgorithm
-    VERSION = "0.4.0"
+    VERSION = "1.0.0"
   end
 end

openssl-signature_algorithm.gemspec

@@ -9,14 +9,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["gonzalo@cedarcode.com"]
   spec.license = "Apache-2.0"
 
-  spec.summary = "OpenSSL::SignatureAlgorithm helpers for signing and verifying signatures with openssl ruby gem"
-
-  spec.description = <<-DESC
-    Provides OpenSSL::SignatureAlgorithm::ECDSA, OpenSSL::SignatureAlgorithm::RSAPSS
-    and OpenSSL::SignatureAlgorithm::RSAPKCS1 ruby object wrappers on top of OpenSSL::PKey::EC
-    and OpenSSL::PKey::RSA, so that you can reason in terms of signature algorithms when
-    signing and/or verifying signatures, instead of keys.
-  DESC
+  spec.summary = "ECDSA, RSA-PSS and RSA-PKCS#1 algorithms for ruby"
+  spec.description = spec.summary
 
   spec.homepage = "https://github.com/cedarcode/openssl-signature_algorithm"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")