passtools 0.2.0 → 0.3.0

data/README.md

@@ -1,7 +1,9 @@
 # PassTools
 
-Simple ruby wrapper for the PassTools API. API documentation can be
-found at the main [PassTools API wiki](https://github.com/tello/passtools-api/wiki/Methods)
+* Simple ruby wrapper for the PassTools API. 
+* API documentation can be found at the main [PassTools API wiki](https://github.com/tello/passtools-api/wiki/Methods)
+* Indexed documentation for the Ruby SDK is available at [http://tello.github.com/passtools-ruby/](http://tello.github.com/passtools-ruby/).
+
 
 ## Installation
 
@@ -101,7 +103,44 @@ Passtools::Pass.create(5, data)
 You could use the same hash with the update call to edit values in an
 existing Pass based on the same template.  
 
+## Using utility objects
+
+There are some additional methods wrapping the data returned and
+creating an instantiated object that provides some methods for
+convenience
+
+There are three constructors:
+
+`Passtools::Template.build_from_current(template_id)`
+
+returns a Template instance that has read only accessors for the raw
+data, id, field names, and a field data hash that can be used for Pass 
+creation.
+
+`Passtools::Pass.build_from_current(pass_id)`
+
+returns a Pass instance that has read only accessors for id and
+template id. It also has read/write accessors for the raw data
+returned and each of the fields.  Changes to either the raw data or the
+fields can be persisted with the #update method. 
 
+`Passtools::Pass.build_from_template(@template_instance)`
+
+returns a templated Pass instance that has the same accessors as above.
+This instance can be persisted with the #create method. Once it
+persisted, further changes must be persisted with the #update method
+
+## Usage 
+
+Given the same example as above you could:
+
+```
+template = Passtools::Template.build_from_current(5)
+pass = Passtools::Pass.build_from_template(template)
+pass.first_name['value'] = 'Abraham'
+pass.last_name['value] = 'Lincoln'
+pass.create
+```
 
 ## Contributing
 

data/lib/passtools.rb

@@ -13,11 +13,13 @@ module Passtools
   class << self
     attr_accessor :api_key, :url, :download_dir
   end
+
   # Configure through hash
   def self.configure(opts = {})
     opts.each {|k,v| instance_variable_set("@#{k}",v) }
   end
 
+  # Configure with yaml file
   def self.configure_from_file(pathname)
     config = YAML::load(IO.read(pathname))
     configure(config)

data/lib/passtools/pass.rb

@@ -1,6 +1,7 @@
 module Passtools
   class Pass
     extend Request
+    attr_accessor :raw_data
 
     def self.list
       get("/pass") 
@@ -28,6 +29,57 @@ module Passtools
       download_file("/pass/#{pass_id}/download", 'PassToolsPass.pkpass')
     end
 
-  end
+    def self.build_from_current(pass_id)
+      begin
+        response = show(pass_id)
+        self.new(response)
+      rescue RestClient::Exception => e
+        data = MultiJson.load(e.response)
+        data['message'] = e.message
+        new(data)
+      end
+    end
 
+    def self.build_from_template(template)
+      @raw_data = {}
+      @raw_data['templateId'] = template.id
+      @raw_data['passFields'] = template.fields
+      self.new(@raw_data)
+    end
+
+    def initialize(raw_data)
+      @raw_data = raw_data
+      fields = Array(@raw_data['passFields'])
+      fields.each do |k,v|
+        # self.instance_variable_set("@#{k}", v)  ## create and initialize an instance variable for this key/value pair
+        define_singleton_method  k, proc{ @raw_data["passFields"][k.to_s] }
+        define_singleton_method  "#{k}=", proc{ |v| @raw_data["passFields"][k.to_s] = v}
+      end
+    end
+
+    def id
+      @raw_data["id"]
+    end
+
+    def template_id
+      @raw_data["templateId"]
+    end
+
+    def valid?
+      @raw_data.has_key?('id')
+    end
+
+    def create
+      return false if self.id
+      response = self.class.create(template_id, @raw_data["passFields"])
+      new_id = response['id']
+      self.raw_data = response if new_id
+    end
+
+    def update 
+      return false unless self.id
+      self.class.update(id, @raw_data["passFields"])
+    end
+
+  end
 end

data/lib/passtools/template.rb

@@ -1,15 +1,55 @@
 module Passtools
   class Template
     extend Request
+    attr_accessor :raw_data
 
     def self.list
       get("/template/headers")
     end
- 
 
     def self.show(template_id)
       get("/template/#{template_id}")
     end
-  end
 
+    def self.build_from_current(template_id)
+      begin
+        response = show(template_id)
+        new(response)
+      rescue RestClient::Exception => e
+        data = MultiJson.load(e.response)
+        data['message'] = e.message
+        new(data)
+      end
+    end
+
+    def initialize(raw_data)
+      @raw_data = raw_data
+    end
+
+    def id
+      fetch_from_raw('templateHeader','id')
+    end
+
+    # return array of field names
+    def field_names
+      fetch_from_raw('fieldsModel').keys
+    end
+
+    # return hash required for creating a Pass based on this template
+    def fields
+      fetch_from_raw('fieldsModel')
+    end
+
+    def fetch_from_raw(*args)
+      data = @raw_data
+      res = nil
+      args.each { |a| data = data.fetch(a, {}); res = data }
+      res
+    end
+
+    def valid?
+      @raw_data.has_key?('fieldsModel')
+    end
+
+  end
 end

data/lib/passtools/version.rb

@@ -1,3 +1,3 @@
 module Passtools
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/passtools/pass_spec.rb

@@ -28,7 +28,7 @@ describe 'Pass' do
     stub = stub_get("http://foobar.com/pass/55/download", 'contents of pass')
 
     Passtools::Pass.download(55)
-    File.open("PassToolsPass.pkpass", 'r').read.should == "contents of pass"
+    File.open("PassToolsPass.pkpass", 'r').read.should == "\"contents of pass\""
   end
 
   it "calls Passtools API to create new Pass" do
@@ -66,4 +66,57 @@ describe 'Pass' do
     expect {Passtools::Pass.list}.to raise_error(RuntimeError, /You must configure api_key before calling/)
   end
 
+  context "The Pass instance" do
+    context 'when built from succesful api call' do
+      before(:all) do
+        Passtools.configure(:url => 'http://foobar.com',
+                        :api_key => 'i_am_an_api_key')
+        @data = {"id" => 10,
+                 "templateId" => 55,
+                 "passFields" => {"first_name" => {"value" => "first", "required" => false},
+                                  "last_name" => {"value" => "last", "required" => true}}
+               }
+        stub = stub_get("http://foobar.com/pass/10",@data)
+        @pass = Passtools::Pass.build_from_current(10)
+      end
+
+      it "should be valid" do
+        @pass.valid?.should be_true
+      end
+
+      it "should return id" do
+        @pass.id.should == 10 
+      end
+
+      it "should return template id" do
+        @pass.template_id.should == 55 
+      end
+
+      it "should have read accessor for field name data" do
+        @pass.first_name.should ==  {"value" => "first", "required" => false}
+      end 
+
+      it "should have write accessor for field name" do
+        @pass.last_name = {"value" => "last_name", "required" => false}
+        @pass.last_name.should == {"value" => "last_name", "required" => false}
+      end 
+
+    end
+    context "when built from failed api call" do
+
+      it "should capture error information" do
+        stub_error("http://foobar.com/pass/10", 400)
+        @pass = Passtools::Pass.build_from_current(10)
+        @pass.raw_data['message'].should == "400 Bad Request"
+      end
+
+      it "should not be valid" do
+        stub_error("http://foobar.com/pass/10", 400)
+        @pass = Passtools::Pass.build_from_current(10)
+        @pass.valid?.should be_false
+      end
+
+    end
+  end
+ 
 end

data/spec/passtools/template_spec.rb

@@ -20,5 +20,52 @@ describe 'Template' do
     Passtools::Template.show(55)
     stub.should have_been_requested
   end
+
+  context "The Template instance" do
+    context 'when built from succesful api call' do
+      before(:all) do
+        @data = {"templateHeader" => {"id" => 55},
+                "fieldsModel" => {"first_name" => {"value" => "first", "required" => false},
+                                  "last_name" => {"value" => "last", "required" => true}}
+               }
+        stub = stub_get("http://foobar.com/template/55",@data)
+        @template = Passtools::Template.build_from_current(55)
+      end
+
+      it "should return id" do
+        @template.id.should == 55
+      end
+
+      it "should be valid" do
+        @template.valid?.should be_true
+      end
+
+      it "should return the correct field names" do
+        @template.field_names.should == ['first_name', 'last_name']
+      end
+
+      it "should return the correct complete field data" do 
+        @template.fields.should == @data['fieldsModel']
+      end
+
+    end
+    context "when built from failed api call" do
+      before(:all) do
+      end
+
+      it "should capture error information" do
+        stub_error("http://foobar.com/template/55", 400)
+        @template = Passtools::Template.build_from_current(55)
+        @template.raw_data['message'].should == "400 Bad Request"
+      end
+
+      it "should not be valid" do
+        stub_error("http://foobar.com/template/55", 400)
+        @template = Passtools::Template.build_from_current(55)
+        @template.valid?.should be_false
+      end
+
+    end
+  end
   
 end

data/spec/support/passtools_helpers.rb

@@ -1,9 +1,9 @@
 module PasstoolsHelpers
 
-  def stub_get(url, body='{}')
+  def stub_get(url, body={})
     stub_request(:get, url).
       with(:query => {:api_key => 'i_am_an_api_key'}).
-      to_return(:body => body)
+      to_return(:body => MultiJson.dump(body))
   end 
 
   def stub_write(request_type, url, json)
@@ -13,6 +13,14 @@ module PasstoolsHelpers
       to_return(:body => "{}")
   end
 
+
+  def stub_error(url, error)
+    stub_request(:get, url).
+      with(:query => {:api_key => 'i_am_an_api_key'}).
+      to_return(:status => [error],
+                :body => "{\"code\":400,\"description\":\"Invalid Request Parameters.\",\"details\":\"template with id 999 was not found!\"}")
+  end
+
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passtools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -159,3 +159,4 @@ test_files:
 - spec/passtools/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/passtools_helpers.rb
+has_rdoc: