wegift-ruby-client 0.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78e0ef24b5481fd31e4bf96d82f486d48bae2d10
-  data.tar.gz: e90efcb5f259200f4e0f52f556b21259d757b5b4
+  metadata.gz: 5fcd237e45bbafd74525b6521aeb8a9ff7df0645
+  data.tar.gz: 6064d9bb7825783312a0f48fb83b057aae0c0545
 SHA512:
-  metadata.gz: 8031c492f87e7bbd660abd16111064c3494680cfdf74a4c1c0988a6a0c67807d94f11f3e21148c2be9f9f449ecadbe4378204f219de1e8806520bed96067e9eb
-  data.tar.gz: 56e5eaf9f1fdbd766783f86af2953178217816d455af2a86fcf36045403834f70b43ec028510b0f9e88feab0095f2f586a6d2602154c4127710e5546a9e1ad3c
+  metadata.gz: 8b5d6db5ad8960ed3a39cd78352f4461066521b6932e872bae099a97752a8eab8da4de03ed6df442032854dce04685b112b02c587dc673705d160a613d19f9fd
+  data.tar.gz: eeb495aaa807a095f4c62cc7c928ae40d5db74e8c247c7b106703627019fd7a46e2941cc18abf393b828530441bb9cf633ce1065982c9b61c2410beed491615f

data/README.md

@@ -1,6 +1,6 @@
 # WeGift Ruby Client
 
-A simple client for [WeGift.io][wegift] B2B Synchronous API (Document Version 1.2). 
+A simple client for [WeGift.io][wegift] B2B Synchronous API (Document Version 1.4). 
 
 ## Installation
 
@@ -27,25 +27,25 @@ Simple example for ordering a Digital Card
 # a simple client 
 client = Wegift::Client.new(
       :api_host => 'http://sandbox.wegift.io',
-      :api_path => '/api/b2b-sync/v1/auth',
+      :api_path => '/api/b2b-sync/v1',
       :api_key => ENV['AUTH_NAME'],
       :api_secret => ENV['AUTH_PASS'],
       :proxy => ENV['PROXY']
 )
 
-# and a simple request
-order = Wegift::Order.new(
-        :product_code => 'tTV',
+# with all available products
+products = client.products
+
+# post a simple order
+order = client.order(
+        :product_code => products.first.code,
         :delivery => 'direct',
         :amount => '42.00',
         :currency_code => 'USD',
         :external_ref => '123'
 )
 
-# executes the POST (TODO: shared/singleton client?)
-order.post(client) 
-
-# and returns
+# which returns
 if order.is_successful?
 
   # some nice data
@@ -56,8 +56,6 @@ if order.is_successful?
 end
 ```
 
-_See official docs for Product Codes (http://sandbox.wegift.io/product-codes)_
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -73,13 +71,14 @@ rspec
 
 It will load all tapes found in `spec/tapes`, we are using [VCR][vcr].
 
-Optional - If you want/need to remaster all the recordings, you will need a sandbox account. 
+To remaster all recordings, you will need a sandbox account. 
 Add an `.env` file to your root:
 
 ```bash
 # .env
 AUTH_NAME='sandbox_username'
 AUTH_PASS='sandbox_password'
+PROXY='proxy_uri'
 ```
 
 Start the VCR with `rspec` - this should add all Tapes to `spec/tapes`.

data/lib/wegift.rb

@@ -1,5 +1,3 @@
-require_relative 'wegift/models/order'
-
 module Wegift
 
 end

data/lib/wegift/client.rb

@@ -9,7 +9,7 @@ module Wegift
     # supported: basic-http-auth - see: http://sandbox.wegift.io
 
     def initialize(options = {})
-      @api_host = options[:api_host] || 'http://sandbox.wegift.io'
+      @api_host = options[:api_host] || 'https://api-sandbox.wegift.io'
       @api_path = options[:api_path] || '/api/b2b-sync/v1'
       @api_key = options[:api_key].to_s
       @api_secret = options[:api_secret]
@@ -19,22 +19,44 @@ module Wegift
         c.adapter Faraday.default_adapter
         c.options[:proxy] = {
             :uri => URI(options[:proxy])
-        } unless options[:proxy].blank?
+        } unless options[:proxy].nil?
       end
     end
 
-    # KISS since we have only one call!
-    def post(path, payload = {})
-      @connection.post do |req|
+    def request(method, path, payload = {})
+      @connection.send(method) do |req|
         req.url [@api_path, path].join('')
         req.headers['Content-Type'] = 'application/json'
-        req.body = payload.to_json
+        req.body = payload.to_json if method.to_sym.eql?(:post)
+        req.params = payload if method.to_sym.eql?(:get)
       end
     end
 
     # TODO: shared context/connection for all calls
     # keep client => https://github.com/lostisland/faraday#basic-use
 
+    # global methods
+
+    def products()
+      # initialize endpoint
+      products = Wegift::Products.new()
+
+      # get catalogue with context / current connection
+      products.get(self)
+
+      # TODO: shared error handling
+    end
+
+    def product(id = nil)
+      products = Wegift::Product.new(:product_code => id)
+      products.get(self)
+    end
+
+    def order(options)
+      order = Wegift::Order.new(options)
+      order.post(self)
+    end
+
   end
 
 end

data/lib/wegift/models/initializable.rb

@@ -0,0 +1,8 @@
+module Initializable
+  def initialize(params = {})
+    params.each do |key, value|
+      setter = "#{key}="
+      send(setter, value) if respond_to?(setter.to_sym, false)
+    end
+  end
+end

data/lib/wegift/models/order.rb

@@ -4,28 +4,32 @@ class Wegift::Order < Wegift::Response
 
   PATH = '/order-digital-card'
 
-  DELIVERY_TYPE = {:direct => 'direct', :email => 'email'}
+  DELIVERY_METHODS = {:direct => 'direct', :email => 'email'}
+  DELIVERY_FORMATS = {:code => 'raw', :url => 'url-instant'}
 
   # request/payload
-  attr_accessor :product_code, :delivery, :amount, :currency_code, :external_ref
+  attr_accessor :product_code, :currency_code, :amount, :delivery_method, :delivery_format,
+                :notification_email, :delivery_email, :external_ref
 
   # response/success
   attr_accessor :code, :expiry_date, :pin
 
-  def initialize(options = {})
-    @product_code = options[:product_code]
-    @delivery = options[:delivery].eql?(DELIVERY_TYPE[:email]) ? options[:delivery] : DELIVERY_TYPE[:direct]
-    @amount = options[:amount]
-    @currency_code = options[:currency_code]
-    @external_ref = options[:external_ref]
+  def initialize(params = {})
+    super(params)
+    # default/fallback: 'direct'/'raw'
+    @delivery_method = params[:delivery_method] || DELIVERY_METHODS[:direct]
+    @delivery_format = params[:delivery_format] || DELIVERY_FORMATS[:code]
   end
 
   def payload
     {
         :product_code => @product_code,
-        :delivery => @delivery,
-        :amount => @amount,
         :currency_code => @currency_code,
+        :amount => @amount,
+        :delivery_method => @delivery_method,
+        :delivery_format => delivery_format,
+        :notification_email => @notification_email,
+        :delivery_email => @delivery_email,
         :external_ref => @external_ref,
     }
   end
@@ -33,7 +37,7 @@ class Wegift::Order < Wegift::Response
   # Order Digital Card
   # POST /api/b2b-sync/v1/order-digital-card
   def post(ctx)
-    response = ctx.post(PATH, self.payload)
+    response = ctx.request(:post, PATH, self.payload)
     self.parse(JSON.parse(response.body))
   end
 

data/lib/wegift/models/product.rb

@@ -0,0 +1,35 @@
+require_relative 'response'
+
+class Wegift::Product < Wegift::Response
+
+  PATH = '/products'
+
+  # request/payload
+  attr_accessor :product_code
+
+  # response/success
+  attr_accessor :code, :name, :description, :currency_code, :availability,
+                :denomination_type, :minimum_value, :maximum_value,
+                :card_image_url, :terms_and_conditions_url, :expiry_date_policy
+
+  def initialize(params = {})
+    super
+  end
+
+  def path
+    [PATH, @product_code.to_s].join('/')
+  end
+
+  # Product Details List
+  # GET /api/b2b-sync/v1/products/ID
+  def get(ctx)
+    response = ctx.request(:get, path)
+    self.parse(JSON.parse(response.body))
+  end
+
+  def parse(data)
+    super(data)
+    Wegift::Product.new(data)
+  end
+
+end

data/lib/wegift/models/products.rb

@@ -0,0 +1,23 @@
+require_relative 'response'
+
+class Wegift::Products < Wegift::Response
+
+  PATH = '/products'
+
+  # Product Details List
+  # GET /api/b2b-sync/v1/products/
+  def get(ctx)
+    response = ctx.request(:get, PATH)
+    self.parse(JSON.parse(response.body))
+  end
+
+  def parse(data)
+    super(data)
+
+    # TODO separate?
+    if data['products']
+      data['products'].map{|p| Wegift::Product.new(p)}
+    end
+  end
+
+end

data/lib/wegift/models/response.rb

@@ -1,4 +1,7 @@
+require_relative 'initializable'
+
 class Wegift::Response
+  include Initializable
 
   STATUS = {:success => 'SUCCESS', :error => 'ERROR'}
 

data/lib/wegift/version.rb

@@ -1,3 +1,4 @@
 module Wegift
-  VERSION = '0.1.1'
+  # api-version.lib-build
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wegift-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Klaas Endrikat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -173,7 +173,10 @@ files:
 - bin/setup
 - lib/wegift.rb
 - lib/wegift/client.rb
+- lib/wegift/models/initializable.rb
 - lib/wegift/models/order.rb
+- lib/wegift/models/product.rb
+- lib/wegift/models/products.rb
 - lib/wegift/models/response.rb
 - lib/wegift/version.rb
 - wegift-ruby-client.gemspec