zipmark 0.0.1.beta.10 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 182b2e5fcdd45ab02d17a1bb1929a15e8ff32dd6
+  data.tar.gz: ffb4526a00d6b9a25c9b85d9a8ecac58f716fe6e
+SHA512:
+  metadata.gz: 4f8931c22d63a4fa904994cdc366034e4ade4e654bc4dcb8d9768a924954b65168027fa68d667c262ffa358718550c9138cece796c368fb9861cf6dd18b6a967
+  data.tar.gz: d4659a17ce9cc02c5bacc5ed4d71220d06f6abcfd5fc566e33fc50b493a14a488eac538e78e9c2f11030e6d8e89d6305919d1cf55245e6895b81b96ab64c6011

data/README.md

@@ -123,10 +123,36 @@ The Zipmark_Iterator can be used to iterate through all objects of a given resou
 
 The client is able to process, verify and extract data from callbacks received from the Zipmark service.
 
+#### Setting up a Callback
+
+Callbacks have to be enabled by creating a callback with an event type and the callback URL. To enable Zipmark to send a callback:
+
+```ruby
+callback = client.callbacks.create(
+  :url => 'https://example.com/callback',
+  :event => 'name_of_event')
+```
+
+The possible event names include:
+
+ * bill.create
+ * bill.update
+ * bill_payment.create
+ * bill_payment.update
+
 #### Loading a callback response
 
 #### Verifying a callback
 
+To verify a callback, you need the entire request (headers, request body, etc.) so it has to be done from the context of the controller layer (or a model that is passed the entire request).
+
+```ruby
+# In a controller:
+client.build_callback(request).valid?
+```
+
+Will return true or false, based on a signed header from Zipmark.
+
 #### Retrieving the callback data
 
 Valid callbacks contain events, object types and objects.  The below functions will return their respective values/objects, or null if the callback is invalid.
@@ -144,3 +170,53 @@ bundle install
 
 bundle exec rake spec
 ```
+
+
+#### Creating a Token
+
+For a Workflow
+```
+workflow = client.workflow.create(name: 'enrollment', data: { customer_id: 'some unique permanent id' })
+workflow.token
+```
+
+For a Display
+```
+display = client.display.create(name: 'recent-transaction', data: { customer_id: 'some unique permanet id' })
+display.token
+```
+
+
+#### Deposits Resource
+
+**Get deposits**
+`client.get('deposits')`
+
+**Get a specific deposit**
+`client.get('deposits/DEPOSIT_ID')`
+
+**Cancel a deposit**
+`client.put('deposits/DEPOSIT_ID/cancel', '')`
+
+**Make a Depost**
+```ruby
+body = { :deposit => { :customer_identifier => 'their unique and permanent identifier', :amount_cents => 1000, :memo => 'an example memo' } }
+client.post('deposits', body)
+```
+
+#### Customers Resource
+
+**Get Customers**
+`client.get('customers')`
+
+**Get a specific customer**
+`client.get('customers/CUSTOMER_ID')`
+
+#### Accounts Resource
+
+**Get accounts**
+`client.get('accounts')`
+
+**Get a specific account**
+`client.get('accounts/ACCOUNT_ID')`
+

data/lib/zipmark.rb

@@ -9,6 +9,11 @@ require 'zipmark/pagination'
 require 'zipmark/resource'
 require 'zipmark/util'
 require 'zipmark/version'
+require 'zipmark/token'
+require 'zipmark/display'
+require 'zipmark/display_proxy'
+require 'zipmark/workflow'
+require 'zipmark/workflow_proxy'
 
 require 'zipmark/adapters/httpclient_adapter'
 
@@ -21,7 +26,7 @@ module Zipmark
   SANDBOX_API_ENDPOINT = 'https://sandbox.zipmark.com'
 
   # Public: String Representing the Current Zipmark API Version
-  API_VERSION = 'v2'
+  API_VERSION = 'v3'
 
   # Public: Error that is raised when a client is expected but not found
   class ClientError < StandardError; end

data/lib/zipmark/adapters/httpclient_adapter.rb

@@ -14,7 +14,11 @@ module Zipmark
       end
 
       def initialize_client
-        client = HTTPClient.new
+        client = HTTPClient.new(
+          default_header: { 'Content-Type' => 'application/json', 'Accept' => api_accept_mime },
+          force_basic_auth: true
+        )
+        client.ssl_config.ssl_version = :TLSv1
         client.set_auth(api_endpoint, username, password)
         return client
       end
@@ -28,19 +32,19 @@ module Zipmark
       end
 
       def get(path)
-        httpclient.get(url_for(path), adapter_options)
+        httpclient.get(url_for(path))
       end
 
       def post(path, body)
-        httpclient.post(url_for(path), adapter_options.merge(:body => body.to_json))
+        httpclient.post(url_for(path), :body => body.to_json)
       end
 
       def put(path, body)
-        httpclient.put(url_for(path), adapter_options.merge(:body => body.to_json))
+        httpclient.put(url_for(path), :body => body.to_json)
       end
 
       def delete(path)
-        httpclient.delete(url_for(path), adapter_options)
+        httpclient.delete(url_for(path))
       end
 
       def url_for(path)
@@ -57,13 +61,6 @@ module Zipmark
       def validation_error?(response)
         response.code == 422
       end
-
-      private
-      def adapter_options
-        {
-          :header => { 'Content-Type' => 'application/json', 'Accept' => api_accept_mime }
-        }
-      end
     end
   end
 end

data/lib/zipmark/client.rb

@@ -92,13 +92,21 @@ module Zipmark
       @resources[meth.to_s] || raise(NoMethodError, "No resource or method: '#{meth}'")
     end
 
+    def display
+      DisplayProxy.new(self)
+    end
+
+    def workflow
+      WorkflowProxy.new(self)
+    end
+
     private
     def load_resources
       hash = {}
       response = get("/")
       object = JSON.parse(response.body)
       if successful?(response)
-        object["vendor_root"]["links"].each {|link| hash[link["rel"]] = Resource.new({ :client => self }.merge(link)) }
+        object["root"]["links"].each {|link| hash[link["rel"]] = Resource.new({ :client => self }.merge(link)) }
       else
         raise Zipmark::Error.new(object)
       end

data/lib/zipmark/display.rb

@@ -0,0 +1,21 @@
+class Display
+  attr_accessor :client, :data, :name
+
+  def initialize(options = {})
+    self.client = options[:client]
+    self.data = options[:data]
+    self.name = options[:name]
+  end
+
+  def token
+    JWT.encode(
+      {
+        display: name,
+        application_id: client.adapter.username,
+        iat:     Time.now.to_i,
+        data:    data
+      },
+      client.adapter.password
+    )
+  end
+end

data/lib/zipmark/display_proxy.rb

@@ -0,0 +1,11 @@
+class DisplayProxy
+  attr_accessor :client
+
+  def initialize(client)
+    self.client = client
+  end
+
+  def create(options = {})
+    Display.new(options.merge(client: client))
+  end
+end

data/lib/zipmark/entity.rb

@@ -29,6 +29,10 @@ module Zipmark
       attributes["id"]
     end
 
+    def indentifier
+      attributes['identifier']
+    end
+
     def method_missing(meth, *args, &block)
       if meth =~ /=$/
         dirty_attributes[meth.to_s.sub(/=$/, '')] = args.first
@@ -60,7 +64,7 @@ module Zipmark
     end
 
     def valid?
-      !!(id && errors.empty?)
+      !!((id ||identifier) && errors.empty?)
     end
 
     def updated_at

data/lib/zipmark/link.rb

@@ -1,6 +1,6 @@
 module Zipmark
   class Link
-    attr_accessor :name, :title, :href
+    attr_accessor :rel, :title, :href
 
     def initialize(options)
       link = Util.stringify_keys(options)
@@ -8,17 +8,5 @@ module Zipmark
       @title = link["title"]
       @href = link["href"]
     end
-
-    def rel
-      @rel
-    end
-
-    def title
-      @title
-    end
-
-    def href
-      @href
-    end
   end
 end

data/lib/zipmark/token.rb

@@ -0,0 +1,9 @@
+require 'jwt'
+
+module Zipmark
+  class Token
+    def self.encode(payload, application_secret)
+      JWT.encode(payload, application_secret)
+    end
+  end
+end

data/lib/zipmark/version.rb

@@ -1,3 +1,3 @@
 module Zipmark
-  VERSION = '0.0.1.beta.10'
+  VERSION = '0.1.0'
 end

data/lib/zipmark/workflow.rb

@@ -0,0 +1,21 @@
+class Workflow
+  attr_accessor :client, :data, :name
+
+  def initialize(options = {})
+    self.client = options[:client]
+    self.data = options[:data]
+    self.name = options[:name]
+  end
+
+  def token
+    JWT.encode(
+      {
+        workflow: name,
+        application_id: client.adapter.username,
+        iat:     Time.now.to_i,
+        data:    data
+      },
+      client.adapter.password
+    )
+  end
+end

data/lib/zipmark/workflow_proxy.rb

@@ -0,0 +1,11 @@
+class WorkflowProxy
+  attr_accessor :client
+
+  def initialize(client)
+    self.client = client
+  end
+
+  def create(options = {})
+    Workflow.new(options.merge(client: client))
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipmark
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta.10
-  prerelease: 6
+  version: 0.1.0
 platform: ruby
 authors:
 - Jake Howerton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies: []
 description: Simple Client Library to connect to the Zipmark API
 email: jake@zipmark.com
@@ -17,6 +16,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- lib/zipmark.rb
 - lib/zipmark/action.rb
 - lib/zipmark/adapters/httparty_adapter.rb
 - lib/zipmark/adapters/httpclient_adapter.rb
@@ -24,6 +27,8 @@ files:
 - lib/zipmark/callback.rb
 - lib/zipmark/client.rb
 - lib/zipmark/collection.rb
+- lib/zipmark/display.rb
+- lib/zipmark/display_proxy.rb
 - lib/zipmark/documentation.rb
 - lib/zipmark/entity.rb
 - lib/zipmark/error.rb
@@ -32,34 +37,32 @@ files:
 - lib/zipmark/link.rb
 - lib/zipmark/pagination.rb
 - lib/zipmark/resource.rb
+- lib/zipmark/token.rb
 - lib/zipmark/util.rb
 - lib/zipmark/version.rb
-- lib/zipmark.rb
-- LICENSE
-- CONTRIBUTING.md
-- README.md
+- lib/zipmark/workflow.rb
+- lib/zipmark/workflow_proxy.rb
 homepage: http://rubygems.org/gems/zipmark
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Zipmark API Client Library
 test_files: []