aws_agcod 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTJiYjU2ZTg4ZjBlNTQ2YjZmOWQ0MWQ2MTVhN2E1NzllYjkyY2YxZg==
+  data.tar.gz: !binary |-
+    MGE1MGUxMTNiMjhmODMwMjQ1ZDdjNWIyYmQ4MzQ0NWMyODY4NDljOA==
+SHA512:
+  metadata.gz: !binary |-
+    NThjZDBiOTMwZTc3YTI0MTZmNjVjY2U3MDI3YWY3NjgwZjQ1Yzk2OWFlMzIx
+    OGUzYmI3OWMxMjM2YjJjYWQxMjhhZTM0MDEzNjgyMmQ2NDZmMTI5ODJhZWRk
+    ZmIwNTI4NDFmYzRkNjhlYWJjZTIxMzg0NDIzNThjNTVlNmZjN2Q=
+  data.tar.gz: !binary |-
+    MzNkOGQ4ZTY5NjdhYzQ5YTBhN2NjOTJkM2ZiODgyODczODEwZGY3MzIxNGRk
+    OTMyNjAxMTJhNTQxY2E0NTVhODIwMzM0ZGM4MDdjNjE2ZWUxYTViZDlmZDcw
+    NjFjMThkMGExZTMyNThmZjJjNmNiNGI0ZjI5ZjlhN2E2MTFlMTA=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+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,31 @@
+# AwsAgcod
+
+Amazon Gift Code On Demand (AGCOD) API v2 implementation for distribute Amazon gift cards (gift codes) instantly in any denomination.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aws_agcod'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aws_agcod
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/aws_agcod/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/aws_agcod.rb

@@ -0,0 +1,33 @@
+require "aws_agcod/version"
+require "aws_agcod/create_gift_card"
+require "aws_agcod/cancel_gift_card"
+
+module AwsAgcod
+  ROOT_PATH = if defined?(Rails)
+    Rails.root
+  else
+    Pathname.new(__FILE__).join("../..").expand_path
+  end
+
+  def self.env
+    if defined?(Rails)
+      Rails.env
+    else
+      @enviroment || "development"
+    end
+  end
+
+  def self.env=(enviroment)
+    @enviroment = enviroment
+  end
+
+  def self.config_file
+    @config_file || ROOT_PATH.join("config/agcod.yml")
+  end
+
+  def self.config_file=(file_path)
+    if ROOT_PATH.join(file_path).exist?
+      @config_file = ROOT_PATH.join(file_path)
+    end
+  end
+end

data/lib/aws_agcod/cancel_gift_card.rb

@@ -0,0 +1,13 @@
+require "aws_agcod/request"
+
+module AwsAgcod
+  class CancelGiftCard
+    extend Forwardable
+
+    def_delegators :@response, :success?, :error_message
+
+    def initialize(request_id, gc_id)
+      @response = Request.new("CancelGiftCard", request_id, "gcId" => gc_id).response
+    end
+  end
+end

data/lib/aws_agcod/create_gift_card.rb

@@ -0,0 +1,30 @@
+require "aws_agcod/request"
+
+module AwsAgcod
+  class CreateGiftCard
+    extend Forwardable
+
+    def_delegators :@response, :success?, :error_message
+
+    def initialize(request_id, amount)
+      @response = Request.new("CreateGiftCard", request_id,
+        "value" => {
+          "currencyCode" => "USD",
+          "amount" => amount
+        }
+      ).response
+    end
+
+    def claim_code
+      @response.payload["gcClaimCode"]
+    end
+
+    def gc_id
+      @response.payload["gcId"]
+    end
+
+    def request_id
+      @response.payload["creationRequestId"]
+    end
+  end
+end

data/lib/aws_agcod/request.rb

@@ -0,0 +1,52 @@
+require "aws_agcod/signature"
+require "aws_agcod/response"
+require "httparty"
+require "yaml"
+
+module AwsAgcod
+  class Request
+    TIME_FORMAT = "%Y%m%dT%H%M%SZ"
+
+    attr_reader :response
+
+    def initialize(action, request_id, params)
+      @action = action
+      @request_id = request_id
+      @params = params
+
+      @response = Response.new(HTTParty.post(uri, body: body, headers: signed_headers, timeout: 30).body)
+    end
+
+    private
+
+    def signed_headers
+      time = Time.now.utc
+
+      headers = {
+        "content-type" => "application/json",
+        "x-amz-date" => time.strftime(TIME_FORMAT),
+        "accept" => "application/json",
+        "host" => uri.host,
+        "x-amz-target" => "com.amazonaws.agcod.AGCODService.#{@action}",
+        "date" => time.to_s
+      }
+
+      Signature.new(config).sign(uri, headers, body)
+    end
+
+    def config
+      @config ||= YAML.load_file(AwsAgcod.config_file)[AwsAgcod.env]
+    end
+
+    def uri
+      @uri ||= URI("#{config["uri"]}/#{@action}")
+    end
+
+    def body
+      @body ||= @params.merge(
+        "partnerId" => config["partner_id"],
+        "creationRequestId" => "#{config["partner_id"]}#{@request_id}"
+      ).to_json
+    end
+  end
+end

data/lib/aws_agcod/response.rb

@@ -0,0 +1,25 @@
+require "json"
+
+module AwsAgcod
+  class Response
+    attr_reader :status, :payload
+
+    def initialize(raw_json)
+      @payload = JSON.parse(raw_json)
+
+      # All status:
+      # SUCCESS -- Operation succeeded
+      # FAILURE -- Operation failed
+      # RESEND -- A temporary/recoverable system failure that can be resolved by the partner retrying the request
+      @status = payload["status"] ? payload["status"] : payload["agcodResponse"]["status"]
+    end
+
+    def success?
+      status == "SUCCESS"
+    end
+
+    def error_message
+      "#{payload["errorCode"]} #{payload["errorType"]} - #{payload["message"]}"
+    end
+  end
+end

data/lib/aws_agcod/signature.rb

@@ -0,0 +1,96 @@
+# Currently AGCOD v2 uses v4 Signature for it's authentication,
+# this class generates signed headers for making proper request to AGCOD service.
+#
+# Based on https://github.com/ifeelgoods/aws4/blob/master/lib/aws4/signer.rb
+require "openssl"
+require "uri"
+require "pathname"
+
+module AwsAgcod
+  class Signature
+    SERVICE = "AGCODService"
+    DEFAULT_REGION = "us-east-1"
+
+    def initialize(credentials)
+      @access_key = credentials["access_key"]
+      @secret_key = credentials["secret_key"]
+      @region = credentials["region"] || DEFAULT_REGION
+    end
+
+    def sign(uri, headers, body = "")
+      @uri = uri
+      @headers = headers
+      @body = body
+      @date = headers["x-amz-date"]
+
+      signed_headers = headers.dup
+      signed_headers["Authorization"] = authorization
+
+      signed_headers
+    end
+
+    private
+
+    def authorization
+      [
+        "AWS4-HMAC-SHA256 Credential=#{@access_key}/#{credential_string}",
+        "SignedHeaders=#{@headers.keys.map(&:downcase).sort.join(";")}",
+        "Signature=#{signature}"
+      ].join(", ")
+    end
+
+    # Reference http://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html
+    def signature
+      k_date = hmac("AWS4" + @secret_key, @date[0, 8])
+      k_region = hmac(k_date, @region)
+      k_service = hmac(k_region, SERVICE)
+      k_credentials = hmac(k_service, "aws4_request")
+      hexhmac(k_credentials, string_to_sign)
+    end
+
+    # Reference http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html
+    def string_to_sign
+      @string_to_sign ||= [
+        "AWS4-HMAC-SHA256", # Algorithm
+        @date, # RequestDate
+        credential_string, # CredentialScope
+        hexdigest(canonical_request) # HashedCanonicalRequest
+      ].join("\n")
+    end
+
+    def credential_string
+      @credential_string ||= [@date[0, 8], @region, SERVICE, "aws4_request"].join("/")
+    end
+
+    # Reference http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html
+    def canonical_request
+      @canonical_request ||= [
+        "POST", # HTTPRequestMethod
+        Pathname.new(@uri.path).cleanpath.to_s, # CanonicalURI
+        @uri.query, # CanonicalQueryString
+        @headers.sort.map { |k, v| [k.downcase, v.strip].join(":") }.join("\n") + "\n", # CanonicalHeaders
+        @headers.sort.map { |k, v| k.downcase }.join(";"), # SignedHeaders
+        hexdigest(@body) # HexEncode(Hash(RequestPayload))
+      ].join("\n")
+    end
+
+    # Hexdigest simply produces an ascii safe way
+    # to view the bytes produced from the hash algorithm.
+    # It takes the hex representation of each byte
+    # and concatenates them together to produce a string
+    def hexdigest(value)
+      Digest::SHA256.new.update(value).hexdigest
+    end
+
+    # Hash-based message authentication code (HMAC)
+    # is a mechanism for calculating a message authentication code
+    # involving a hash function in combination with a secret key
+    def hmac(key, value)
+      OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new("sha256"), key, value)
+    end
+
+    def hexhmac(key, value)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new("sha256"), key, value)
+    end
+  end
+end

data/lib/aws_agcod/version.rb

@@ -0,0 +1,3 @@
+module AwsAgcod
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: aws_agcod
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Xenor Chang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: ! "Amazon Gift Code On Demand (AGCOD) API v2 implementation for\n                          distribute
+  Amazon gift cards (gift codes) instantly in any denomination"
+email:
+- xenor@listia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/aws_agcod.rb
+- lib/aws_agcod/cancel_gift_card.rb
+- lib/aws_agcod/create_gift_card.rb
+- lib/aws_agcod/request.rb
+- lib/aws_agcod/response.rb
+- lib/aws_agcod/signature.rb
+- lib/aws_agcod/version.rb
+homepage: https://github.com/listia/aws-agcod
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: AWS AGCOD API v2 endpoints implementation
+test_files: []