gyft 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c1c0ffab416b657c24a3fd61b540aad3acbfa7f
-  data.tar.gz: 6f2b7861756994f00a09ec0d0d7b0494ae33ab54
+  metadata.gz: 00dbb14a4c26ddb4f896a49b20991d911ace9961
+  data.tar.gz: c7ac360ff24ff8d4b4928cd144e1db4df36e3374
 SHA512:
-  metadata.gz: 48aeab58c47e06e66194b53dabbbf8b65274905a9559d0561a53e7a1489640cc1f6c1d6c90c05409be6dff1d35dd2128da5bfc82509ed19645d1607ca1504c8d
-  data.tar.gz: bcf5d626a9719a50f81e143293f748035dbc497b056fd75f02049519698929cbaac7a5b0df8e379160e4a65a2d4d996fa9b22d8a776ed1fafd5d1de7eaf84841
+  metadata.gz: 519a6fa76e89dc5d070585652334ad4ceb78618ea19d3feb9e1eb6d7586899324c35d3490e71b4d4b6e84668b9274a8b8e2b85fd7a64fbc4d0ae3a886667c072
+  data.tar.gz: b478b953e428c936ef65367c77e8b167018b26174f465c0f2c9cad34576f4113f0fd79df77a29e5b137fcedb16575383a6576fd5dd7ee2c969d1b69091f24eda

data/README.md

@@ -1 +1,226 @@
 # Ruby API library for the Gyft API
+
+[![Gem Version](https://badge.fury.io/rb/gyft.svg)](https://badge.fury.io/rb/gyft) [![Build Status](https://travis-ci.org/cbetta/gyft.svg?branch=master)](https://travis-ci.org/cbetta/gyft)
+
+A wrapper for the [Gyft API](http://developer.gyft.com). Specification as per the [developer documentation](http://developer.gyft.com/io-docs).
+
+## Installation
+
+Either install directly or via bundler.
+
+```rb
+gem 'gyft'
+```
+
+## Getting started
+
+The client will accept the API key and secret either as parameters on initialization,
+or as environment variables. Additionally an `environment` can be set to either
+`sandbox` (default) or `production`.
+
+```rb
+require 'gyft'
+
+# using parameters
+client = Gyft::Client.new(api_key: '...', api_secret: '...', environment: 'production')
+
+# using these environment variables are set:
+# * GYFT_RESELLER_API_KEY
+# * GYFT_RESELLER_API_SECRET
+# * GYFT_RESELLER_API_ENVIRONMENT
+client = Gyft::Client.new
+
+# now you are ready for your first API call
+client.reseller.shop_cards # => [#<Gyft::Card id=123, merchant_id="123", ...>, ...]
+```
+
+## API
+
+### GET /health/check
+
+```rb
+# with a connection
+> client.health.check
+true
+
+# without a connection
+> client.health.check
+false
+```
+
+### GET /reseller/shop_cards
+
+Returns the shop cards available for purchase.
+
+```rb
+> cards = client.reseller.shop_cards
+[#<Gyft::Card id=123, merchant_id="123", ...>, ...]
+> cards.first
+Gyft::Card {
+                            :id => 3028,
+                   :merchant_id => "211-1346844972352-24",
+                 :merchant_name => "Foot Locker",
+              :long_description => "<p>Foot Locker is ...</p>",
+            :card_currency_code => "USD",
+               :opening_balance => 50.0,
+     :merchant_card_template_id => 3750,
+            :cover_image_url_hd => "http://imagestest.gyft.com/merchants_cards/c-211-1346844972355-64_cover_hd.png",
+    :merchant_icon_image_url_hd => "http://imagestest.gyft.com/merchants/i-211-1346844972353-0_hd.png"
+}
+```
+
+### GET /reseller/categories
+
+Returns all of the categories.
+
+```rb
+> categories = client.reseller.categories
+[#<Gyft::Category id=4, name="Babies & Children">, ... ]
+> categories.first
+Gyft::Category {
+      :id => 4,
+    :name => "Babies & Children"
+}
+```
+
+### GET /reseller/merchants
+
+Returns all of the merchants.
+
+```rb
+> merchants = client.reseller.merchants
+[#<Gyft::Merchant id="123", name="foobar.com", ...>, ... ]
+> merchants.first
+Gyft::Merchant {
+                       :id => "1406228802381_103",
+                     :name => "1-800-Baskets.com",
+              :description => "Gift baskets for every occasion. ",
+         :long_description => "<p>1-800-Baskets has ...</p>",
+             :country_code => "US",
+           :homepage_label => "Go to 1800baskets.com",
+             :homepage_url => "http://www.1800baskets.com",
+              :facebook_id => "229053644398",
+               :twitter_id => "1800baskets",
+                :google_id => "+1800baskets",
+               :shop_cards => [#
+        [0] Gyft::Card {
+                         :id => 4456,
+              :currency_code => "USD",
+                      :price => 25.0,
+            :opening_balance => 25.0
+        },
+        [1] Gyft::Card {
+                         :id => 4461,
+              :currency_code => "USD",
+                      :price => 50.0,
+            :opening_balance => 50.0
+        }
+    ],
+               :categories => [
+        [0] Gyft::Category {
+              :id => 12,
+            :name => "Home Goods"
+        }
+    ],
+               :meta_title => "Buy 1-800-Baskets.com Gift Cards | Gyft",
+         :meta_description => "1-800-Baskets.com",
+           :min_card_value => 25.0,
+           :max_card_value => 50.0,
+       :cover_image_url_hd => "http://imagestest.gyft.com/merchants_cards/default-08_cover_hd.png",
+          :google_plus_url => "https://plus.google.com/+1800baskets",
+              :twitter_url => "https://twitter.com/1800baskets",
+                :card_name => "1-800-Baskets.com",
+                 :icon_url => "http://imagestest.gyft.com/merchants/1-800-baskets_hd.png",
+    :legal_disclaimer_html => "...",
+             :facebook_url => "http://www.facebook.com/229053644398"
+}
+```
+
+### GET /reseller/account
+
+Returns details of the reseller's account.
+
+```rb
+> account = client.reseller.account
+Gyft::Account {
+                      :id => "abc123",
+       :global_shop_cards => true,
+
+                :username => "foobar",
+                    :name => "FooBar",
+        :application_name => "FooBar",
+            :contact_name => "FooBar Developer",
+           :contact_email => "foo@example.com",
+                 :balance => 50000.0,
+    :balance_updated_when => 1469051680000
+}
+```
+
+### GET /reseller/transactions
+
+Returns a list of all the transactions for the reseller.
+
+```rb
+> transactions = client.reseller.transactions
+[#<Gyft::Transaction id=123, type=1, amount=25.0, created_when=1469034701000>, ...]
+> transactions.first
+Gyft::Transaction {
+              :id => 123,
+            :type => 1,
+          :amount => 25.0,
+    :created_when => 1469034701000
+}
+```
+
+### GET /transactions/last/:number_of_records
+
+Returns a limited list of recent transactions for the reseller.
+
+```rb
+> transactions = client.reseller.transactions(last: 1)
+[#<Gyft::Transaction id=123, type=1, amount=25.0, created_when=1469034701000>]
+> transactions.first
+Gyft::Transaction {
+              :id => 123,
+            :type => 1,
+          :amount => 25.0,
+    :created_when => 1469034701000
+}
+```
+
+### GET /transactions/first/:number_of_records
+
+Returns a limited list of initial transactions for the reseller.
+
+```rb
+> transactions = client.reseller.transactions(first: 1)
+[#<Gyft::Transaction id=122, type=1, amount=25.0, created_when=1469034701000>]
+> transactions.first
+Gyft::Transaction {
+              :id => 122,
+            :type => 1,
+          :amount => -25.0,
+    :created_when => 1469034701000
+}
+```
+
+### GET /transaction/:id
+
+Returns a full details for a sent transaction
+
+```rb
+> client.transaction(123)
+Gyft::Transaction {
+                     :id => 123,
+          :merchant_name => "Grotto",
+
+                 :amount => 25.0,
+                :sent_to => "customer@example.com",
+         :auto_delivered => "N",
+               :revealed => "N",
+            :gift_status => 6,
+            :card_status => 0,
+    :transaction_created => 1469034701000,
+           :gift_created => 1469034701000
+}
+```

data/gyft.gemspec

@@ -15,4 +15,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rake')
   s.add_development_dependency('webmock')
   s.add_development_dependency('minitest')
+  s.add_development_dependency('awesome_print')
 end

data/lib/gyft.rb

@@ -1 +1,9 @@
 require 'gyft/version'
+require 'gyft/client'
+require 'gyft/client/health'
+require 'gyft/client/reseller'
+require 'gyft/card'
+require 'gyft/category'
+require 'gyft/merchant'
+require 'gyft/account'
+require 'gyft/transaction'

data/lib/gyft/account.rb

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

data/lib/gyft/card.rb

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

data/lib/gyft/category.rb

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

data/lib/gyft/client.rb

@@ -0,0 +1,100 @@
+require 'net/https'
+require 'digest'
+require 'json'
+
+module Gyft
+  class Client
+    class Error < StandardError; end
+    class ServerError < Error; end
+
+    ENDPOINTS = {
+      'production' => 'api.gyft.com',
+      'sandbox' => 'apitest.gyft.com'
+    }
+
+    attr_accessor :api_key, :api_secret, :environment, :http
+
+    def initialize(options = {})
+      @api_key = options.fetch(:api_key) do
+        ENV['GYFT_RESELLER_API_KEY'] ||
+        ArgumentError.new("Missing required argument: api_key")
+      end
+
+      @api_secret = options.fetch(:api_secret) do
+        ENV['GYFT_RESELLER_API_SECRET'] ||
+        ArgumentError.new("Missing required argument: api_secret")
+      end
+
+      @environment = begin
+        environment = options.fetch(:environment) do
+          ENV['GYFT_RESELLER_API_ENVIRONMENT'] || 'sandbox'
+        end
+        unless %w{production sandbox}.include?(environment)
+          raise ArgumentError.new("Invalid argument: environment should be one of 'production' or 'sandbox'")
+        end
+        environment
+      end
+
+      @http = Net::HTTP.new(ENDPOINTS[environment], Net::HTTP.https_default_port)
+      http.use_ssl = true
+    end
+
+    def health
+      Gyft::Client::Health.new(self)
+    end
+
+    def reseller
+      Gyft::Client::Reseller.new(self)
+    end
+
+    def get(path, params = {}, headers = {})
+      uri, timestamp = uri_for(path, params)
+      message = Net::HTTP::Get.new(uri.request_uri)
+      message['x-sig-timestamp'] = timestamp
+      headers.each { |key, value| message[key] = value }
+      transmit(message)
+    end
+
+    private
+
+    def uri_for(path, params = {})
+      uri = URI("https://#{ENDPOINTS[environment]}/mashery/v1#{path}")
+      sig, timestamp = signature
+      uri.query = URI.encode_www_form({
+        api_key: api_key,
+        sig: sig
+      })
+      [uri, timestamp]
+    end
+
+    def signature
+      timestamp = Time.now.getutc.to_i.to_s
+      plaintext = api_key + api_secret + timestamp
+      [Digest::SHA256.new.hexdigest(plaintext), timestamp]
+    end
+
+    def transmit(message)
+      parse(http.request(message))
+    end
+
+    def parse response
+      case response
+      when Net::HTTPSuccess
+        json?(response) ? JSON.parse(response.body) : response.body
+      else
+        if json?(response)
+          raise ServerError, "HTTP #{response.code}: #{JSON.parse(response.body)}"
+        else
+          raise ServerError, "HTTP #{response.code}: #{response.body}"
+        end
+      end
+    end
+
+    def json?(response)
+      content_type = response['Content-Type']
+      json_header = content_type && content_type.split(';').first == 'application/json'
+      has_body = response.body && response.body.length > 0
+      json_header && has_body
+    end
+  end
+end

data/lib/gyft/client/health.rb

@@ -0,0 +1,13 @@
+class Gyft::Client::Health
+
+  def initialize client
+    @client = client
+  end
+
+  def check
+    @client.get('/health/check')
+    true
+  rescue SocketError
+    false
+  end
+end

data/lib/gyft/client/reseller.rb

@@ -0,0 +1,69 @@
+
+require 'awesome_print'
+
+class Gyft::Client::Reseller
+
+  def initialize client
+    @client = client
+  end
+
+  def shop_cards
+    @client.get('/reseller/shop_cards').map do |card|
+      Gyft::Card.new(card)
+    end
+  end
+
+  def categories
+    @client.get('/reseller/categories')['details'].map do |category|
+      Gyft::Category.new(category)
+    end
+  end
+
+  def merchants
+    @client.get('/reseller/merchants')['details'].map do |merchant|
+      merchant = Gyft::Merchant.new(merchant)
+      merchant.shop_cards = merchant.shop_cards.map do |card|
+        Gyft::Card.new(card)
+      end
+      merchant.categories = merchant.categories.map do |category|
+        Gyft::Category.new(category)
+      end
+      merchant
+    end
+  end
+
+  def account
+    result = @client.get('/reseller/account')
+    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)
+  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
+  end
+end

data/lib/gyft/merchant.rb

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

data/lib/gyft/transaction.rb

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

data/lib/gyft/version.rb

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

data/spec/gyft_spec.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'gyft'
+
+describe 'Gyft::Reseller' do
+
+  before do
+    @client = Gyft::Client.new(api_key: '123', api_secret: '234')
+  end
+
+  describe '.health.check' do
+    it 'should return the result' do
+      stub_request(:get, /apitest.gyft.com\/mashery/)
+        .to_return(status: 200, body: "", headers: {})
+      @client.health.check.must_equal(true)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gyft
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cristiano Betta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper for the Gyft API
 email: cbetta@gmail.com
 executables: []
@@ -62,7 +76,16 @@ files:
 - README.md
 - gyft.gemspec
 - lib/gyft.rb
+- lib/gyft/account.rb
+- lib/gyft/card.rb
+- lib/gyft/category.rb
+- lib/gyft/client.rb
+- lib/gyft/client/health.rb
+- lib/gyft/client/reseller.rb
+- lib/gyft/merchant.rb
+- lib/gyft/transaction.rb
 - lib/gyft/version.rb
+- spec/gyft_spec.rb
 homepage: https://github.com/cbetta/gyft
 licenses:
 - MIT