dvelp_api_auth 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 503dc12200bdbfde4944ed4eaa69eaf12ca14b1f
-  data.tar.gz: 481956fccaf7b850ae135db41400f0d8de6e822b
+  metadata.gz: dfb4ebfdc55abb3d82c25e4f38b0121f475f25fd
+  data.tar.gz: 02fac34e7addd44c53a5486880a2c5ba7164a8d1
 SHA512:
-  metadata.gz: 1a7ae4632157f1dca253c805c3e1d24b9994f9d332d820941e5ba8beecf1dde7a6a10bedf558ba950eafd994d72f621c003364d48cfebb4f2dc621770ad1c8d6
-  data.tar.gz: f7f2be92e1cf99b0367bc74f33b680660a86e61be6d74dcc04b07cfc104d19d41209271b87021ad673a155d34fcb0a7d24756a7a35b9d4694781811d173b87ff
+  metadata.gz: c64ae020f43e8e5d9a9eac9462f875d240a5ac273fe14b309f23aec140d72db9ddf7edbb9dd005ba6793494ceb928cae6e32db1a36273516dff574da4009d14b
+  data.tar.gz: b049c295a6d2af36476c8a72410ac0bc274d20ecfa57204e4e78ceb9a9c34b423d9bfb40dc5cacc4cef40a08a5421ab9c16f63fc59afbca3f029fa37c19fae48

data/README.md

@@ -20,10 +20,14 @@ Or install it yourself as:
 
 ## Usage
 
-First of all you need to set env variable to encrypt requests:
+Set the secret key for the API:
 
 ```ruby
-ENV['DVELP_API_AUTH_SECRET_KEY'] = 'Some key'
+# config/initializers/dvelp_api_auth.rb
+
+DvelpApiAuth.configure do |config|
+  config.api_auth_secret_key = 'strong secret'
+end
 ```
 
 ## Development
@@ -32,6 +36,39 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Integration with API
+
+#### Example of generating headers on JS
+
+In this example we used [crypto-js](https://www.npmjs.com/package/crypto-js) javascript library.
+
+```javascript
+// Require library
+const CryptoJS = require("crypto-js");
+
+// Secret key
+const DVELP_API_AUTH_SECRET_KEY = 'dvelp-api-auth-secret-key';
+
+// Value for AUTHORISATION header
+const generateAuthHeader = (timestamp) => {
+  const path = '/path-to-action'; // (URI) example '/api/resources/:id'
+  const path_utf8 = CryptoJS.enc.Utf8.parse(path);
+  const string = timestamp + CryptoJS.enc.Base64.stringify(path_utf8);
+
+  return CryptoJS.HmacSHA256(string, DVELP_API_AUTH_SECRET_KEY);
+};
+
+// Time of the request
+const timestamp = Math.floor(Date.now() / 1000);
+
+// Headers which we send with every request
+{
+  'ACCEPT': 'application/vnd.api+json',
+  'TIMESTAMP': timestamp,
+  'AUTHORISATION': generateAuthHeader(timestamp)
+}
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dvelp_api_auth.

data/lib/dvelp_api_auth.rb

@@ -3,4 +3,15 @@ require 'dvelp_api_auth/helper_methods'
 Gem.find_files('dvelp_api_auth/**/*.rb').each { |f| require f }
 
 module DvelpApiAuth
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/dvelp_api_auth/authentication/signature.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+
 require 'base64'
+require 'openssl'
 
 module DvelpApiAuth
   module Authentication
@@ -9,17 +11,21 @@ module DvelpApiAuth
       attr_accessor :raw_post, :request_timestamp, :body, :multipart
 
       def initialize(
-        fullpath, raw_post, request_timestamp, multipart = false, body = nil
+        fullpath,
+        raw_post,
+        request_timestamp,
+        multipart = false,
+        body = nil,
+        api_secret_key = DvelpApiAuth.configuration.api_auth_secret_key
       )
         @fullpath = fullpath
         @raw_post = raw_post
         @request_timestamp = request_timestamp
         @multipart = multipart
         @body = body
+        @api_secret_key = api_secret_key
 
-        unless present?(@request_timestamp)
-          raise 'Request full_path is required'
-        end
+        raise 'Request full_path is required' unless present?(@fullpath)
         raise 'Timestamp is required' unless present?(@request_timestamp)
       end
 
@@ -28,7 +34,7 @@ module DvelpApiAuth
 
         OpenSSL::HMAC.hexdigest(
           OpenSSL::Digest.new('SHA256'),
-          app_secret_key,
+          @api_secret_key,
           string
         )
       end
@@ -54,10 +60,6 @@ module DvelpApiAuth
         Base64.strict_encode64(string).chomp
       end
 
-      def app_secret_key
-        ENV['DVELP_API_AUTH_SECRET_KEY']
-      end
-
       def multipart?
         @multipart
       end

data/lib/dvelp_api_auth/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DvelpApiAuth
+  class Configuration
+    attr_accessor :api_auth_secret_key
+
+    def initialize(api_auth_secret_key: ENV['DVELP_API_AUTH_SECRET_KEY'])
+      self.api_auth_secret_key = api_auth_secret_key
+    end
+  end
+end

data/lib/dvelp_api_auth/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module DvelpApiAuth
-  VERSION = '0.1.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dvelp_api_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Egor Vorobiev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,8 +102,8 @@ files:
 - lib/dvelp_api_auth/authentication/api_request.rb
 - lib/dvelp_api_auth/authentication/signature.rb
 - lib/dvelp_api_auth/authentication/validator.rb
+- lib/dvelp_api_auth/configuration.rb
 - lib/dvelp_api_auth/helper_methods.rb
-- lib/dvelp_api_auth/tests/helpers.rb
 - lib/dvelp_api_auth/version.rb
 homepage: 
 licenses: []
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: It provides auth between bridge and DE apps

data/lib/dvelp_api_auth/tests/helpers.rb

@@ -1,30 +0,0 @@
-module DvelpApiAuth
-  module Tests
-    module Helpers
-      def authorize!(fullpath, request_params = {})
-        set_authorisation_header(fullpath, request_params)
-        set_timestamp
-      end
-
-      private
-
-      def set_authorisation_header(fullpath, request_params)
-        if request_params.present? && request_params.is_a?(Hash)
-          raw_post = request_params.to_query
-        end
-
-        http_auth = DvelpApiAuth::Authentication::Signature.new(
-          fullpath,
-          raw_post,
-          Time.current
-        ).generate
-
-        request.env['HTTP_AUTHORISATION'] = http_auth
-      end
-
-      def set_timestamp
-        request.env['HTTP_TIMESTAMP'] = Time.current
-      end
-    end
-  end
-end