zipmark 0.0.1.beta.8 → 0.0.1.beta.10

data/README.md

@@ -33,7 +33,6 @@ client = Zipmark::Client.new(
 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.
@@ -53,16 +52,50 @@ client = Zipmark::Client.new(
 client.bills.find("bill-id")
 ```
 
+Attempting to find a bill that doesn't exist will raise a Zipmark::NotFound error.
+
 ### Discovering available resources
 
 Resources will contain an array of all available resources.
 
+```ruby
+client.resources.keys
+```
+
 ### Creating a new Bill
 
 Create a bill object, set required attributes, send it to Zipmark
 
+```ruby
+bill = client.bills.create(
+  :identifier => "1234",
+  :amount_cents => 100,
+  :bill_template_id => bill_template_id,
+  :memo => "My memo",
+  :content => '{"memo":"My Memo"}',
+  :customer_id => "Customer 1",
+  :date => "20130805")
+```
+
 As an alternative, it is possible to build an object first and then save it afterwards
 
+```ruby
+bill = client.bills.build(
+  :identifier => "1234",
+  :amount_cents => 100,
+  :bill_template_id => bill_template_id,
+  :memo => "My memo",
+  :content => '{"memo":"My Memo"}',
+  :customer_id => "Customer 1",
+  :date => "20130805")
+bill.save
+```
+
+Regardless of which method is used, if a bill is valid, it was successfully saved to Zipmark:
+
+```ruby
+puts bill.errors unless bill.valid?
+```
 
 ### Updating an existing Bill
 
@@ -103,3 +136,11 @@ Valid callbacks contain events, object types and objects.  The below functions w
 Please see the [Zipmark API](https://dev.zipmark.com) or contact Zipmark Support via [email](mailto:developers@zipmark.com) or [chat](http://bit.ly/zipmarkAPIchat) for more information.
 
 ## Unit/Acceptance Tests
+
+Tests are written in rspec.  To run the full test suite, execute the following:
+
+```
+bundle install
+
+bundle exec rake spec
+```

data/lib/zipmark.rb

@@ -4,6 +4,7 @@ require 'zipmark/collection'
 require 'zipmark/entity'
 require 'zipmark/error'
 require 'zipmark/iterator'
+require 'zipmark/link'
 require 'zipmark/pagination'
 require 'zipmark/resource'
 require 'zipmark/util'
@@ -27,4 +28,7 @@ module Zipmark
 
   # Public: Error that is raised when a Resource is malformed or invalid
   class ResourceError < StandardError; end
+
+  # Public: Error that is raised when a Resource cannot be found
+  class NotFoundError < StandardError; end
 end

data/lib/zipmark/client.rb

@@ -36,6 +36,10 @@ module Zipmark
       @identifier
     end
 
+    def resources
+      @resources
+    end
+
     # Public: Send a GET Request to the given API Path
     #
     # path - A String which can be a relative path to the API root, or a full URL

data/lib/zipmark/collection.rb

@@ -10,7 +10,7 @@ module Zipmark
     end
 
     def items
-      iterator.current_items
+      iterator.items
     end
 
     def length

data/lib/zipmark/entity.rb

@@ -1,6 +1,6 @@
 module Zipmark
   class Entity
-    attr_accessor :attributes, :client, :resource_type, :errors, :dirty_attributes
+    attr_accessor :attributes, :client, :resource_type, :errors, :dirty_attributes, :links
 
     def initialize(options={})
       @errors = {}
@@ -8,6 +8,17 @@ module Zipmark
       @dirty_attributes = {}
       @client = @attributes.delete("client")
       @resource_type = @attributes.delete("resource_type")
+      set_links
+    end
+
+    def set_links
+      @links = {}
+      object_links = @attributes.delete("links")
+      if object_links.kind_of?(Array)
+        object_links.each do |link|
+          @links[link["rel"]] = Link.new(link)
+        end
+      end
     end
 
     def inspect
@@ -27,8 +38,8 @@ module Zipmark
     end
 
     def save
-      if url
-        response = client.put(url, resource_type => dirty_attributes)
+      if links["self"]
+        response = client.put(links["self"].href, resource_type => dirty_attributes)
       else
         response = client.post("/#{resource_type}s", resource_type => attributes)
       end
@@ -40,6 +51,7 @@ module Zipmark
       object = JSON.parse(response.body)
       if client.successful?(response)
         @attributes = object[resource_type]
+        set_links
       elsif client.validation_error?(response)
         @errors = object["errors"]
       else
@@ -51,11 +63,6 @@ module Zipmark
       !!(id && errors.empty?)
     end
 
-    def url
-      link = links.detect {|link| link["rel"] == "self" } if links && !links.empty?
-      link["href"] if link
-    end
-
     def updated_at
       Time.parse(attributes["updated_at"]) if attributes["updated_at"]
     end

data/lib/zipmark/error.rb

@@ -1,5 +1,14 @@
 module Zipmark
   class Error < StandardError
-    attr_accessor :classification, :messages, :code
+    attr_accessor :status
+
+    def initialize(error)
+      self.status = error.delete(:status)
+      super(error)
+    end
+
+    def not_found?
+      status == 404
+    end
   end
 end

data/lib/zipmark/iterator.rb

@@ -37,7 +37,7 @@ module Zipmark
     end
 
     def next_item
-      item =  @items.fetch(@items.index(current_item) + 1) rescue nil
+      item = @items.fetch(@items.index(current_item) + 1) rescue nil
       if item
         @current_item = item
       else

data/lib/zipmark/link.rb

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

data/lib/zipmark/resource.rb

@@ -11,9 +11,13 @@ module Zipmark
     end
 
     def find(id)
-      json = client.get("/" + rel + "/" + id).body
-      object = JSON.parse(json)
-      Zipmark::Entity.new(object[resource_name].merge(:client => client, :resource_type => resource_name))
+      response = client.get("/" + rel + "/" + id)
+      object = JSON.parse(response.body)
+      if client.successful?(response)
+        Zipmark::Entity.new(object[resource_name].merge(:client => client, :resource_type => resource_name))
+      else
+        raise Zipmark::Error.new(!!object ? object.merge(:status => response.status) : response)
+      end
     end
 
     def build(options)

data/lib/zipmark/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipmark
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta.8
+  version: 0.0.1.beta.10
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-07 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies: []
 description: Simple Client Library to connect to the Zipmark API
 email: jake@zipmark.com
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Zipmark API Client Library