gyft 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 430c2c8154291101cc09ba954792337d3d81ec03
-  data.tar.gz: 2cc655c695a6b1808c3ae2bab91b1500dc933098
+  metadata.gz: 8e6eeace4f248958e53b36ea5adcff736fbdedc8
+  data.tar.gz: dc6b3b16b6c9b3cc78c6c9c6958ead8a44178aa7
 SHA512:
-  metadata.gz: 82f72fb65b37d149546bea4bc5df1ebc2101579473472f2a541583f7c3149f32f9058a3b46a2998b7ba500e1f630541cc8585535cf9c59b91c3f61ba46813394
-  data.tar.gz: 6903ddb6c74b2bdaa0d3e1bd3923ce366377c3a75ca23ebc96bfadbe714319e40c953615300bd648ba356d398c95cbc11a45de73e4a68b5f9f553b39f1c27032
+  metadata.gz: 543e7cf9d0e3cb507861c3ec4190767c26f0df1a0858448334e7de46fff2dfe3c5579a03ef3cffed148fd453b5c03e5d9ebfc680dfe19db2e80d740ae6dde5ac
+  data.tar.gz: 8111036baa68ba2a81b4420d57a7b2e912490fe4ed79259f516702cfb39801b3e6c5ce950fba7430ac4601354d5c9c67093b1e1c93ef903ece18383af950d670

data/README.md

@@ -38,15 +38,35 @@ The client provides with direct access to every API call as documented in the de
 
 ```rb
 # get a card to purchase
-card = client.reseller.shop_cards.first
+card = client.cards.first
 # purchase the card for someone
-transaction = card.purchase(to_email: 'customer@example.com', shop_card_id: 1234)
+transaction = card.purchase(to_email: 'customer@example.com')
 # load more details on the transaction
 transaction = transaction.reload
 # refund the transaction
 transaction.refund
 ```
 
+## Convenience methods
+
+### `client.cards`
+
+Maps to `client.reseller.shop_cards`, allows for easier access and a less verbose DSL.
+
+### `card.purchase`
+
+Maps to `client.partner.purchase.gift_card_direct` and passes along all the same parameters while automatically setting the `shop_card_id`.
+
+### `transaction.reload`
+
+The purchase method returns an incomplete transaction object. This convenience methods
+calls `client.reseller.transaction.find` passing along the transaction `id` and returns a
+new `Gyft::Transaction` object.
+
+### `transaction.refund`
+
+Maps to `client.reseller.transactions.refund` and automatically passes along the transaction `id`.
+
 ## API
 
 ### GET /health/check
@@ -271,3 +291,21 @@ Gyft::Transaction {
     :url => "https://staging.gyft.com/card/#/?c=...."
 }
 ```
+
+## Contributing
+
+ 1. **Fork** the repo on GitHub
+ 2. **Clone** the project to your own machine
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to your fork
+ 5. Submit a **Pull request** so that we can review your changes
+
+### Development
+
+* `bundle install` to get dependencies
+* `rake` to run tests
+* `rake console` to run a local console with the library loaded
+
+## License
+
+This library is released under the [MIT License](LICENSE).

data/lib/gyft/card.rb

@@ -1,2 +1,6 @@
 class Gyft::Card < OpenStruct
+  def purchase params = {}
+    params[:shop_card_id] = id
+    client.partner.purchase.gift_card_direct(params)
+  end
 end

data/lib/gyft/client.rb

@@ -4,8 +4,7 @@ require 'json'
 
 module Gyft
   class Client
-    class Error < StandardError; end
-    class ServerError < Error; end
+    class ServerError < StandardError; end
 
     ENDPOINTS = {
       'production' => 'api.gyft.com',
@@ -39,6 +38,10 @@ module Gyft
       http.use_ssl = true
     end
 
+    def cards
+      reseller.shop_cards
+    end
+
     def health
       Gyft::Client::Health.new(self)
     end

data/lib/gyft/client/partner.rb

@@ -11,8 +11,11 @@ class Gyft::Client::Partner
     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)
+
+    transaction = @client.post("/partner/purchase/gift_card_direct", options)
+    
+    transaction[:client] = @client
+    Gyft::Transaction.new(transaction)
   end
 
   private

data/lib/gyft/client/reseller.rb

@@ -6,23 +6,28 @@ class Gyft::Client::Reseller
 
   def shop_cards
     @client.get('/reseller/shop_cards').map do |card|
+      card[:client] = @client
       Gyft::Card.new(card)
     end
   end
 
   def categories
     @client.get('/reseller/categories')['details'].map do |category|
+      category[:client] = @client
       Gyft::Category.new(category)
     end
   end
 
   def merchants
     @client.get('/reseller/merchants')['details'].map do |merchant|
+      merchant[:client] = @client
       merchant = Gyft::Merchant.new(merchant)
       merchant.shop_cards = merchant.shop_cards.map do |card|
+        card[:client] = @client
         Gyft::Card.new(card)
       end
       merchant.categories = merchant.categories.map do |category|
+        category[:client] = @client
         Gyft::Category.new(category)
       end
       merchant
@@ -30,8 +35,9 @@ class Gyft::Client::Reseller
   end
 
   def account
-    result = @client.get('/reseller/account')
-    Gyft::Account.new(result)
+    account = @client.get('/reseller/account')
+    account[:client] = @client
+    Gyft::Account.new(account)
   end
 
   def transactions

data/lib/gyft/client/transactions.rb

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

data/lib/gyft/transaction.rb

@@ -1,2 +1,9 @@
 class Gyft::Transaction < OpenStruct
+  def reload
+    client.reseller.transactions.find(id)
+  end
+
+  def refund
+    client.reseller.transactions.refund(id)
+  end
 end

data/lib/gyft/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gyft
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Cristiano Betta