zipmark 0.0.1.beta.2 → 0.0.1.beta.3

data/README.md

@@ -4,20 +4,49 @@ The Zipmark Ruby Client library is used to interact with Zipmark's [API](https:/
 
 ## Installation
 
-### Requirements
+```sh
+gem install zipmark
+```
+or in your Gemfile
 
-## Initialization
-
-## Usage Examples
+```ruby
+gem "zipmark"
+```
 
 ### Instantiating a client
 
-Application Identifier and Application Secret should be replaced with the vendor application identifier and secret provided by Zipmark.
+```ruby
+require 'zipmark'
+
+client = Zipmark::Client.new(
+  :application_id => "app-id",
+  :application_secret => "my-secret",
+  :vendor_identifier => "vendor-ident"
+)
+```
+
+Vendor Identifier, Application Identifier, Application Secret should be replaced with the 
+values provided by Zipmark.
+
 
 ### Production Mode
 
+By default, Zipmark::Client sends all requests to our sandbox environment.  This environment is identical to production except money never actually is moved.  When you are putting your application into production and want people to actually be able to pay, you need to turn production mode on.
+
+```ruby
+client = Zipmark::Client.new(
+  :application_id => "app-id",
+  :application_secret => "my-secret",
+  :vendor_identifier => "vendor-ident",
+  :production => true
+)
+```
+
 ### Loading a Bill from a known Bill ID
 
+```ruby
+client.bills.find("bill-id")
+```
 
 ### Discovering available resources
 

data/lib/zipmark/adapters/httparty_adapter.rb

@@ -37,6 +37,14 @@ module Zipmark
         self.class.delete(path, adapter_options)
       end
 
+      def successful?(response)
+        response.code >= 200 && response.code < 300
+      end
+
+      def validation_error?(response)
+        response.code == 422
+      end
+
       private
       def adapter_options
         {

data/lib/zipmark/adapters/httpclient_adapter.rb

@@ -50,6 +50,14 @@ module Zipmark
         end
       end
 
+      def successful?(response)
+        response.code >= 200 && response.code < 300
+      end
+
+      def validation_error?(response)
+        response.code == 422
+      end
+
       private
       def adapter_options
         {

data/lib/zipmark/client.rb

@@ -60,6 +60,20 @@ module Zipmark
       adapter.delete(path)
     end
 
+    # Public: Check for an ok response code (200-299)
+    #
+    # response - A response object specific to the adapter
+    def successful?(response)
+      adapter.successful?(response)
+    end
+
+    # Public: Check for a validation error response (422)
+    #
+    # response - A response object specific to the adapter
+    def validation_error?(response)
+      adapter.validation_error?(response)
+    end
+
     def build_callback(request)
       Zipmark::Callback.new(request, :client => self)
     end

data/lib/zipmark/entity.rb

@@ -34,10 +34,10 @@ module Zipmark
 
     def apply_response(response)
       object = JSON.parse(response.body)
-      if response.ok?
+      if client.successful?(response)
         @attributes = object[resource_type]
-      elsif response.code == 422
-        @errors = object
+      elsif client.validation_error?(response)
+        @errors = object["errors"]
       else
         raise Zipmark::Error.new(object)
       end

data/lib/zipmark/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipmark
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta.2
+  version: 0.0.1.beta.3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies: []
 description: Simple Client Library to connect to the Zipmark API
 email: jake@zipmark.com