atalanda-signature 1.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in atalanda-signature.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dominik Goltermann
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+
+AtalandaSignature-ruby
+==================
+
+AtalandaSignature-ruby provides a simple Ruby class that lets you sign requests to the [atalogics API](http://atalogics.com) and verify our callbacks.
+
+Installation
+============
+
+The best way to install the library is by using bundler. Add the following to `Gemfile` in the root of your project:
+
+``` 
+gem "atalanda-signature"
+```
+
+Then, on the command line:
+
+``` bash
+bundle install
+```
+
+Usage
+=====
+
+Signing API calls
+-----------------
+Use this to add an auth_hash containing a valid signature to the parameter hash that you send to our API.
+``` ruby
+parameters = {
+  "atalogics" => {}
+}
+token = Atalanda::Signature::Token.new(KEY, SECRET)
+request = Atalanda::Signature::Request.new("POST", "api/order", parameters)
+signed_parameters = request.sign(token)
+=>
+{
+  "atalogics" => {},
+  "auth_timestamp" => 1391167211,
+  "auth_key" => "[Your API key]",
+  "auth_signature" => "552beac4b99949a556b120b7e5f7e22def46f663992a08f0f132ad4afee68b9f"
+}
+```
+
+Verifying the signature of our callbacks
+--------------
+Use this to verify the signature of our callbacks.
+``` ruby
+data = JSON.parse(body) // convert json from post body into ruby hash
+token = Atalanda::Signature::Token.new(KEY, SECRET)
+request = Atalanda::Signature::Request.new("POST", "api/order", data)
+result = request.authenticate(token)
+
+if result["authenticated"] == true
+  // signature is valid
+end
+```
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/atalanda-signature.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atalanda/signature/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "atalanda-signature"
+  spec.version       = Atalanda::Signature::VERSION
+  spec.authors       = ["Dominik Goltermann"]
+  spec.email         = ["dominik@goltermann.cc"]
+  spec.description   = %q{Gem for signing atalogics api calls}
+  spec.summary       = %q{Gem for signing atalogics api calls}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "debugger"
+end

data/lib/atalanda/signature.rb

@@ -0,0 +1,104 @@
+require "atalanda/signature/version"
+require "digest"
+
+module Atalanda
+  module Signature
+    class Token
+      attr_accessor :api_key, :api_secret
+
+      def initialize(app_api_key, app_api_secret)
+        self.api_key=app_api_key
+        self.api_secret=app_api_secret
+      end
+    end 
+
+    class Request
+      def initialize(method, path, parameters, time=Time.now)
+        @method = method.upcase
+        @path = path
+        @parameters = parameters
+        @time = time.to_i
+      end
+
+      def sign(token)
+        param_string = buildParameterString()
+        signature = calculateSignature(token, param_string, @time)
+        @parameters.merge!({
+          "auth_timestamp" => @time,
+          "auth_key" => token.api_key,
+          "auth_signature" => signature
+        })
+      end
+
+      def authenticate token, timestamp_grace=600
+        if get_auth_hash.nil?
+          return {
+            "authenticated" => false,
+            "reason" => "Auth hash is missing"
+          }
+        end
+
+        if @time - get_auth_hash["auth_timestamp"].to_i > timestamp_grace
+          return {
+            "authenticated" => false,
+            "reason" => "Auth timestamp is older than #{timestamp_grace} seconds"
+          }
+        end
+
+        recalculated_signature = calculateSignature(token, buildParameterString(), get_auth_hash["auth_timestamp"])
+        if recalculated_signature != get_auth_hash["auth_signature"]
+          return {
+            "authenticated" => false,
+            "reason" => "Signature does not match"
+          }
+        end
+
+        {
+          "authenticated" => true
+        }
+      end
+
+      private
+
+        def get_auth_hash
+          if @parameters.has_key?("auth_key") && @parameters.has_key?("auth_signature") && @parameters.has_key?("auth_timestamp")
+            return {
+              "auth_timestamp" => @parameters["auth_timestamp"],
+              "auth_key" => @parameters["auth_key"],
+              "auth_signature" => @parameters["auth_signature"]
+            }
+          else
+            return nil
+          end
+        end
+
+        def calculateSignature token, string, time
+          Digest::SHA256.hexdigest("#{string}#{token.api_key}#{token.api_secret}#{time}")
+        end
+
+        def buildParameterString
+          "#{@method}#{@path}#{canonical_string_from_hash(@parameters)}"
+        end
+
+        def canonical_string_from_hash value, key=nil
+          str = ""
+          return "" if key == "auth_key" || key == "auth_timestamp" || key == "auth_signature"
+
+          if value.is_a? Hash
+            str += key.to_s
+            value.keys.sort.each do |k|
+              str += canonical_string_from_hash(value[k], k)
+            end
+          elsif value.is_a? Array
+            str += key.to_s
+            value.each do |v|
+              str += canonical_string_from_hash(v)
+            end
+          else
+            str += key ? "#{key}#{value}" : value.to_s
+          end
+          return str
+        end
+    end
+  end
+end

data/lib/atalanda/signature/version.rb

@@ -0,0 +1,5 @@
+module Atalanda
+  module Signature
+    VERSION = "1.0.2"
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: atalanda-signature
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Dominik Goltermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for signing atalogics api calls
+email:
+- dominik@goltermann.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- atalanda-signature.gemspec
+- lib/atalanda/signature.rb
+- lib/atalanda/signature/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gem for signing atalogics api calls
+test_files: []
+has_rdoc: