aws_agcod 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTJiYjU2ZTg4ZjBlNTQ2YjZmOWQ0MWQ2MTVhN2E1NzllYjkyY2YxZg==
+    OGZjMTRlM2Q2ZjhlYjMzZjdiMjE1NmIxNjk3NThjNjM5YTdmODc3YQ==
   data.tar.gz: !binary |-
-    MGE1MGUxMTNiMjhmODMwMjQ1ZDdjNWIyYmQ4MzQ0NWMyODY4NDljOA==
+    MjZjNzkxNmZhZWVmYzA4OTQzNTUxNWFhMmFjYmNjMDM5MjQwN2Q3OQ==
 SHA512:
   metadata.gz: !binary |-
-    NThjZDBiOTMwZTc3YTI0MTZmNjVjY2U3MDI3YWY3NjgwZjQ1Yzk2OWFlMzIx
-    OGUzYmI3OWMxMjM2YjJjYWQxMjhhZTM0MDEzNjgyMmQ2NDZmMTI5ODJhZWRk
-    ZmIwNTI4NDFmYzRkNjhlYWJjZTIxMzg0NDIzNThjNTVlNmZjN2Q=
+    ZDdlMGI0ZmQ0MGM3ZjhhNzNiZmY0YWVkMTZiNmI0NTY2MTVhNzYwM2VkM2Y4
+    NGM5NDIyZjI3YWUwZjAxYjkzZGJkZmNkOWZiZDA5MGM3ODEwOGM5ZmJhZTJh
+    YzdiZTc5YTFkNjIzYWY2OWU2OWRkZjNjY2UyNDU5MjM0M2I1ODM=
   data.tar.gz: !binary |-
-    MzNkOGQ4ZTY5NjdhYzQ5YTBhN2NjOTJkM2ZiODgyODczODEwZGY3MzIxNGRk
-    OTMyNjAxMTJhNTQxY2E0NTVhODIwMzM0ZGM4MDdjNjE2ZWUxYTViZDlmZDcw
-    NjFjMThkMGExZTMyNThmZjJjNmNiNGI0ZjI5ZjlhN2E2MTFlMTA=
+    NmMyYzE5ODZiMjc0YThmMDQzY2U4ZDkzZWJhNThkZjI5NmM0MWIyNTMzNGU1
+    MmQ4M2QwODUxNDcwMGVjMzAyM2E3ZjE2Y2Q1Yjc4MTg2YWY0NTE3YTEzZDhj
+    OTI1YjRiZGY0Njk4OWQyYWE4NjAwM2YyN2Y5MmI3OTdhNThlYzY=

data/README.md

@@ -20,8 +20,83 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Configure
 
+```ruby
+require "aws_agcod"
+
+AwsAgcod.configure do |config|
+  config.access_key = "YOUR_ACCESS_KEY"
+  config.secret_key = "YOUR_SECRET_KEY"
+  config.partner_id = "PARTNER_ID"
+  config.uri        = "https://agcod-v2-gamma.amazon.com" # default, sandbox endpoint
+  config.partner_id = "us-east-1" # default
+end
+```
+
+#### Create Gift Code/Card
+
+```ruby
+request_id = "test"
+amount = 10 # USD
+
+request = AwsAgcod::CreateGiftCard.new(request_id, amount)
+
+# When succeed
+if request.success?
+  request.claim_code # => code for the gift card
+  request.gc_id # => gift card id
+  request.request_id # => your request id
+else
+# When failed
+  request.error_message # => Error response from AGCOD service
+end
+```
+
+#### Cancel Gift Code/Card
+
+```ruby
+request_id = "test"
+gc_id = "test_gc_id"
+
+request = AwsAgcod::CancelGiftCard.new(request_id, gc_id)
+
+# When failed
+unless request.success?
+  request.error_message # => Error response from AGCOD service
+end
+```
+
+#### Get Gift Code/Card activities
+
+```ruby
+request_id = "test"
+start_time = Time.now - 86400
+end_time = Time.now
+page = 1
+per_page = 100
+show_no_ops = false # Wehther to show activities with no operation or not
+
+request = AwsAgcod::GiftCardActivityList.new(request_id, start_time, end_time, page, per_page, show_no_ops)
+
+# When succeed
+if request.success?
+  request.results.each do |activity|
+    activity.status # => SUCCESS, FAILURE, RESEND
+    activity.created_at
+    activity.type
+    activity.card_number
+    activity.amount
+    activity.error_code
+    activity.gc_id
+    activity.partner_id
+    activity.request_id
+  end
+else
+# When failed
+  request.error_message # => Error response from AGCOD service
+end
+```
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/aws_agcod/fork )

data/lib/aws_agcod.rb

@@ -1,33 +1,19 @@
 require "aws_agcod/version"
+require "aws_agcod/config"
 require "aws_agcod/create_gift_card"
 require "aws_agcod/cancel_gift_card"
+require "aws_agcod/gift_card_activity_list"
 
 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.configure(&block)
+    @config = Config.new
 
-  def self.env=(enviroment)
-    @enviroment = enviroment
-  end
+    yield @config
 
-  def self.config_file
-    @config_file || ROOT_PATH.join("config/agcod.yml")
+    nil
   end
 
-  def self.config_file=(file_path)
-    if ROOT_PATH.join(file_path).exist?
-      @config_file = ROOT_PATH.join(file_path)
-    end
+  def self.config
+    @config
   end
 end

data/lib/aws_agcod/cancel_gift_card.rb

@@ -7,7 +7,10 @@ module AwsAgcod
     def_delegators :@response, :success?, :error_message
 
     def initialize(request_id, gc_id)
-      @response = Request.new("CancelGiftCard", request_id, "gcId" => gc_id).response
+      @response = Request.new("CancelGiftCard",
+        "creationRequestId" => "#{AwsAgcod.config.partner_id}#{request_id}",
+        "gcId" => gc_id
+      ).response
     end
   end
 end

data/lib/aws_agcod/config.rb

@@ -0,0 +1,11 @@
+module AwsAgcod
+  class Config
+    attr_accessor :access_key, :secret_key, :uri, :partner_id, :region
+
+    def initialize
+      # API defaults
+      @uri = "https://agcod-v2-gamma.amazon.com"
+      @region = "us-east-1"
+    end
+  end
+end

data/lib/aws_agcod/create_gift_card.rb

@@ -7,7 +7,8 @@ module AwsAgcod
     def_delegators :@response, :success?, :error_message
 
     def initialize(request_id, amount)
-      @response = Request.new("CreateGiftCard", request_id,
+      @response = Request.new("CreateGiftCard",
+        "creationRequestId" => "#{AwsAgcod.config.partner_id}#{request_id}",
         "value" => {
           "currencyCode" => "USD",
           "amount" => amount

data/lib/aws_agcod/gift_card_activity_list.rb

@@ -0,0 +1,54 @@
+require "aws_agcod/request"
+
+module AwsAgcod
+  class GiftCardActivityListError < StandardError; end
+
+  class GiftCardActivity
+    attr_reader :status, :created_at, :type, :card_number, :amount, :error_code,
+                :gc_id, :partner_id, :request_id
+
+    def initialize(payload)
+      @payload = payload
+      @status = payload["activityStatus"]
+      @created_at = payload["activityTime"]
+      @type = payload["activityType"]
+      @card_number = payload["cardNumber"]
+      @amount = payload["cardValue"]["amount"] if payload["cardValue"]
+      @error_code = payload["failureCode"]
+      @gc_id = payload["gcId"]
+      @partner_id = payload["partnerId"]
+      @request_id = payload["requestId"]
+    end
+
+    def is_real?
+      @payload["isRealOp"] == "true"
+    end
+  end
+
+  class GiftCardActivityList
+    extend Forwardable
+
+    LIMIT = 1000 # limit per request
+    TIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
+    def_delegators :@response, :success?, :error_message
+
+    def initialize(request_id, start_time, end_time, page = 1, per_page = 100, show_no_ops = false)
+      raise GiftCardActivityError, "Only #{LIMIT} records allowed per request." if per_page > LIMIT
+
+      @response = Request.new("GetGiftCardActivityPage",
+        "requestId" => request_id,
+        "utcStartDate" => start_time.strftime(TIME_FORMAT),
+        "utcEndDate" => end_time.strftime(TIME_FORMAT),
+        "pageIndex" => (page - 1) * per_page,
+        "pageSize" => per_page,
+        "showNoOps" => show_no_ops
+      ).response
+    end
+
+    def results
+      @response["cardActivityList"].map { |payload| GiftCardActivity.new(payload) }
+    end
+  end
+end
+

data/lib/aws_agcod/request.rb

@@ -9,9 +9,8 @@ module AwsAgcod
 
     attr_reader :response
 
-    def initialize(action, request_id, params)
+    def initialize(action, params)
       @action = action
-      @request_id = request_id
       @params = params
 
       @response = Response.new(HTTParty.post(uri, body: body, headers: signed_headers, timeout: 30).body)
@@ -31,21 +30,16 @@ module AwsAgcod
         "date" => time.to_s
       }
 
-      Signature.new(config).sign(uri, headers, body)
-    end
-
-    def config
-      @config ||= YAML.load_file(AwsAgcod.config_file)[AwsAgcod.env]
+      Signature.new(AwsAgcod.config).sign(uri, headers, body)
     end
 
     def uri
-      @uri ||= URI("#{config["uri"]}/#{@action}")
+      @uri ||= URI("#{AwsAgcod.config.uri}/#{@action}")
     end
 
     def body
       @body ||= @params.merge(
-        "partnerId" => config["partner_id"],
-        "creationRequestId" => "#{config["partner_id"]}#{@request_id}"
+        "partnerId" => AwsAgcod.config.partner_id
       ).to_json
     end
   end

data/lib/aws_agcod/response.rb

@@ -11,7 +11,13 @@ module AwsAgcod
       # 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"]
+      @status = if payload["status"]
+        payload["status"]
+      elsif payload["agcodResponse"]
+        payload["agcodResponse"]["status"]
+      else
+        "FAILURE"
+      end
     end
 
     def success?

data/lib/aws_agcod/signature.rb

@@ -9,12 +9,11 @@ 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
+      @access_key = credentials.access_key
+      @secret_key = credentials.secret_key
+      @region = credentials.region || DEFAULT_REGION
     end
 
     def sign(uri, headers, body = "")

data/lib/aws_agcod/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_agcod
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Xenor Chang
@@ -85,7 +85,9 @@ files:
 - Rakefile
 - lib/aws_agcod.rb
 - lib/aws_agcod/cancel_gift_card.rb
+- lib/aws_agcod/config.rb
 - lib/aws_agcod/create_gift_card.rb
+- lib/aws_agcod/gift_card_activity_list.rb
 - lib/aws_agcod/request.rb
 - lib/aws_agcod/response.rb
 - lib/aws_agcod/signature.rb