gyft 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00dbb14a4c26ddb4f896a49b20991d911ace9961
-  data.tar.gz: c7ac360ff24ff8d4b4928cd144e1db4df36e3374
+  metadata.gz: 430c2c8154291101cc09ba954792337d3d81ec03
+  data.tar.gz: 2cc655c695a6b1808c3ae2bab91b1500dc933098
 SHA512:
-  metadata.gz: 519a6fa76e89dc5d070585652334ad4ceb78618ea19d3feb9e1eb6d7586899324c35d3490e71b4d4b6e84668b9274a8b8e2b85fd7a64fbc4d0ae3a886667c072
-  data.tar.gz: b478b953e428c936ef65367c77e8b167018b26174f465c0f2c9cad34576f4113f0fd79df77a29e5b137fcedb16575383a6576fd5dd7ee2c969d1b69091f24eda
+  metadata.gz: 82f72fb65b37d149546bea4bc5df1ebc2101579473472f2a541583f7c3149f32f9058a3b46a2998b7ba500e1f630541cc8585535cf9c59b91c3f61ba46813394
+  data.tar.gz: 6903ddb6c74b2bdaa0d3e1bd3923ce366377c3a75ca23ebc96bfadbe714319e40c953615300bd648ba356d398c95cbc11a45de73e4a68b5f9f553b39f1c27032

data/README.md

@@ -34,6 +34,19 @@ client = Gyft::Client.new
 client.reseller.shop_cards # => [#<Gyft::Card id=123, merchant_id="123", ...>, ...]
 ```
 
+The client provides with direct access to every API call as documented in the developer documentation. Additionally it also provides some convenience methods.
+
+```rb
+# get a card to purchase
+card = client.reseller.shop_cards.first
+# purchase the card for someone
+transaction = card.purchase(to_email: 'customer@example.com', shop_card_id: 1234)
+# load more details on the transaction
+transaction = transaction.reload
+# refund the transaction
+transaction.refund
+```
+
 ## API
 
 ### GET /health/check
@@ -161,7 +174,7 @@ Gyft::Account {
 Returns a list of all the transactions for the reseller.
 
 ```rb
-> transactions = client.reseller.transactions
+> transactions = client.reseller.transactions.all
 [#<Gyft::Transaction id=123, type=1, amount=25.0, created_when=1469034701000>, ...]
 > transactions.first
 Gyft::Transaction {
@@ -177,7 +190,7 @@ Gyft::Transaction {
 Returns a limited list of recent transactions for the reseller.
 
 ```rb
-> transactions = client.reseller.transactions(last: 1)
+> transactions = client.reseller.transactions.last(1)
 [#<Gyft::Transaction id=123, type=1, amount=25.0, created_when=1469034701000>]
 > transactions.first
 Gyft::Transaction {
@@ -193,7 +206,7 @@ Gyft::Transaction {
 Returns a limited list of initial transactions for the reseller.
 
 ```rb
-> transactions = client.reseller.transactions(first: 1)
+> transactions = client.reseller.transactions.first(1)
 [#<Gyft::Transaction id=122, type=1, amount=25.0, created_when=1469034701000>]
 > transactions.first
 Gyft::Transaction {
@@ -209,7 +222,7 @@ Gyft::Transaction {
 Returns a full details for a sent transaction
 
 ```rb
-> client.transaction(123)
+> client.transactions.find(123)
 Gyft::Transaction {
                      :id => 123,
           :merchant_name => "Grotto",
@@ -224,3 +237,37 @@ Gyft::Transaction {
            :gift_created => 1469034701000
 }
 ```
+
+### POST /transaction/refund
+
+Refund transaction and get card details.
+
+```rb
+> client.transactions.refund(123)
+Gyft::Refund {
+                            :id => "OTlkOGM1...k5W",
+                        :status => 0,
+
+                :gf_reseller_id => "abc123",
+    :gf_reseller_transaction_id => 123333,
+                         :email => "client@example.com",
+                   :gf_order_id => 123456,
+            :gf_order_detail_id => 345678,
+             :gf_gyfted_card_id => 678997,
+                   :invalidated => false
+}
+```
+
+### POST /partner/purchase/gift_card_direct
+
+```rb
+> client.partner.purchase.gift_card_direct(
+      to_email: 'customer@example.com',
+      shop_card_id: 1234
+  )
+
+Gyft::Transaction {
+     :id => 1250483,
+    :url => "https://staging.gyft.com/card/#/?c=...."
+}
+```

data/lib/gyft.rb

@@ -2,8 +2,11 @@ require 'gyft/version'
 require 'gyft/client'
 require 'gyft/client/health'
 require 'gyft/client/reseller'
+require 'gyft/client/partner'
+require 'gyft/client/transactions'
 require 'gyft/card'
 require 'gyft/category'
 require 'gyft/merchant'
 require 'gyft/account'
 require 'gyft/transaction'
+require 'gyft/refund'

data/lib/gyft/client.rb

@@ -47,11 +47,21 @@ module Gyft
       Gyft::Client::Reseller.new(self)
     end
 
-    def get(path, params = {}, headers = {})
-      uri, timestamp = uri_for(path, params)
+    def partner
+      Gyft::Client::Partner.new(self)
+    end
+
+    def get(path)
+      uri, timestamp = uri_for(path)
       message = Net::HTTP::Get.new(uri.request_uri)
       message['x-sig-timestamp'] = timestamp
-      headers.each { |key, value| message[key] = value }
+      transmit(message)
+    end
+
+    def post(path, params = {})
+      uri, timestamp = uri_for(path, params)
+      message = Net::HTTP::Post.new(uri.request_uri)
+      message['x-sig-timestamp'] = timestamp
       transmit(message)
     end
 
@@ -60,10 +70,10 @@ module Gyft
     def uri_for(path, params = {})
       uri = URI("https://#{ENDPOINTS[environment]}/mashery/v1#{path}")
       sig, timestamp = signature
-      uri.query = URI.encode_www_form({
+      uri.query = URI.encode_www_form(params.merge({
         api_key: api_key,
         sig: sig
-      })
+      }))
       [uri, timestamp]
     end
 

data/lib/gyft/client/partner.rb

@@ -0,0 +1,38 @@
+class Gyft::Client::Partner
+  def initialize client
+    @client = client
+  end
+
+  def purchase
+    self
+  end
+
+  def gift_card_direct params = {}
+    params = symbolize(params)
+    options = extract(params, :to_email, :shop_card_id)
+    options = merge(options, params, :reseller_reference, :notes, :first_name, :last_name, :gender, :birthday)
+    result = @client.post("/partner/purchase/gift_card_direct", options)
+    Gyft::Transaction.new(result)
+  end
+
+  private
+
+  def symbolize params
+    params.inject({}){|hash,(k,v)| hash[k.to_sym] = v; hash}
+  end
+
+  def extract params, *args
+    options = {}
+    args.each do |arg|
+      options[arg] = params.fetch(arg)
+    end
+    options
+  end
+
+  def merge options, params, *args
+    args.each do |arg|
+      options[arg] = params[arg] if params[arg]
+    end
+    options
+  end
+end

data/lib/gyft/client/reseller.rb

@@ -1,6 +1,3 @@
-
-require 'awesome_print'
-
 class Gyft::Client::Reseller
 
   def initialize client
@@ -37,33 +34,11 @@ class Gyft::Client::Reseller
     Gyft::Account.new(result)
   end
 
-  def transactions options = {}
-    path = transactions_path_for(options)
-
-    @client.get(path).map do |transaction|
-      Gyft::Transaction.new(transaction)
-    end
-  end
-
-  def transaction id
-    result = @client.get("/reseller/transaction/#{id}")
-    Gyft::Transaction.new(result)
+  def transactions
+    Gyft::Client::Transactions.new(@client)
   end
 
-  private
-
-  def transactions_path_for(options)
-    last = options[:last]
-    first = options[:first]
-
-    path = begin
-      if last && last > 0
-        "/reseller/transactions/last/#{last}"
-      elsif first && first > 0
-        "/reseller/transactions/first/#{first}"
-      else
-        '/reseller/transactions'
-      end
-    end
+  def transaction
+    Gyft::Client::Transactions.new(@client)
   end
 end

data/lib/gyft/client/transactions.rb

@@ -0,0 +1,34 @@
+class Gyft::Client::Transactions
+
+  def initialize client
+    @client = client
+  end
+
+  def find id
+    result = @client.get("/reseller/transaction/#{id}")
+    Gyft::Transaction.new(result)
+  end
+
+  def all
+    @client.get('/reseller/transactions').map do |transaction|
+      Gyft::Transaction.new(transaction)
+    end
+  end
+
+  def first number_of_records
+    @client.get("/reseller/transactions/first/#{number_of_records}").map do |transaction|
+      Gyft::Transaction.new(transaction)
+    end
+  end
+
+  def last number_of_records
+    @client.get("/reseller/transactions/last/#{number_of_records}").map do |transaction|
+      Gyft::Transaction.new(transaction)
+    end
+  end
+
+  def refund id
+    result = @client.post("/reseller/transaction/refund", id: id)
+    Gyft::Refund.new(result)
+  end
+end

data/lib/gyft/refund.rb

@@ -0,0 +1,2 @@
+class Gyft::Refund < OpenStruct
+end

data/lib/gyft/version.rb

@@ -1,3 +1,3 @@
 module Gyft
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gyft
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Cristiano Betta
@@ -81,8 +81,11 @@ files:
 - lib/gyft/category.rb
 - lib/gyft/client.rb
 - lib/gyft/client/health.rb
+- lib/gyft/client/partner.rb
 - lib/gyft/client/reseller.rb
+- lib/gyft/client/transactions.rb
 - lib/gyft/merchant.rb
+- lib/gyft/refund.rb
 - lib/gyft/transaction.rb
 - lib/gyft/version.rb
 - spec/gyft_spec.rb