passtools 0.3.0 → 0.4.3

data/README.md

@@ -47,6 +47,10 @@ Returns all templates associated with user specified by the api_key
 
 Returns detail information for individual template
 
+`Passtools::Template.delete(template_id)`
+
+Deletes a template from the user's account
+
 `Passtools::Pass.list`
 
 Returns list of all Passes associated with user
@@ -69,6 +73,14 @@ Updates pass data
 Downloads Pass to the directory named by the 'download_dir'
 configuration value.  Passes are named 'PassToolsPass.pkpass'
 
+`Passtools::Pass.delete(pass_id)`
+
+Delete pass from user's account
+
+`Passtools::Pass.push(pass_id)`
+
+Push pass changes to all devices that have the pass installed
+
 ## Example Code
 
 Refer to the [PassTools API wiki](https://github.com/tello/passtools-api/wiki/Methods) for more information about the data returned. Generally you are most likely to be interested in data from the fieldsModel key of the Template detail data.   
@@ -130,6 +142,9 @@ 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
 
+Each Pass or Template instance has access to the API methods that make sense
+for an single object(eg. create, update, push, delete). 
+
 ## Usage 
 
 Given the same example as above you could:

data/lib/passtools/pass.rb

@@ -4,17 +4,17 @@ module Passtools
     attr_accessor :raw_data
 
     def self.list
-      get("/pass") 
+      get("/pass")
     end
 
     def self.list_by_template(template_id)
       #TODO not implemented in API yet
     end
 
-    def self.show(pass_id)
-      get("/pass/#{pass_id}")
+    def self.show(pass_id, params = {})
+      get("/pass/#{pass_id}", params)
     end
-    
+
     def self.create(template_id,data)
       json = MultiJson.dump(data)
       post("/pass/#{template_id}", {:json => json } )
@@ -29,6 +29,14 @@ module Passtools
       download_file("/pass/#{pass_id}/download", 'PassToolsPass.pkpass')
     end
 
+    def self.push(pass_id)
+      put("/pass/#{pass_id}/push")
+    end
+
+    def self.delete(pass_id)
+      delete_request("/pass/#{pass_id}")
+    end
+
     def self.build_from_current(pass_id)
       begin
         response = show(pass_id)
@@ -76,10 +84,27 @@ module Passtools
       self.raw_data = response if new_id
     end
 
-    def update 
+    def update
       return false unless self.id
       self.class.update(id, @raw_data["passFields"])
     end
 
+    def push
+      return false unless self.id
+      self.class.push(id)
+    end
+
+    def delete
+      return false unless self.id
+      response = self.class.delete(id)
+      self.raw_data['id'] = nil if response['Status'] == 'Deleted'
+      response
+    end
+
+    def download
+      return false unless self.id
+      self.class.download(self.id)
+    end
+
   end
 end

data/lib/passtools/request.rb

@@ -4,7 +4,7 @@ module Passtools
     def get(path, params = {})
       url = construct_url(path)
       params.merge!(:api_key => Passtools.api_key)
-      response = RestClient.get(url, :params => params)
+      response = RestClient.get(url, headers.merge(:params => params))
       MultiJson.load(response)
     end
 
@@ -13,21 +13,28 @@ module Passtools
       raise "Download directory is not defined or does not exist" unless filepath.exist?
       url = construct_url(path)
       params = {:api_key => Passtools.api_key}
-      response = RestClient.get(url, :params => params)
+      response = RestClient.get(url, headers.merge(:params => params))
       File.open(filepath.join(filename), 'w') {|f| f.write(response) }
     end
 
     def post(path, params = {})
       url = construct_url(path)
       params.merge!(:api_key => Passtools.api_key )
-      response = RestClient.post(url, params, :multipart => true )
+      response = RestClient.post(url, params, headers.merge(:multipart => true) )
       MultiJson.load(response)
     end
 
     def put(path, params = {})
       url = construct_url(path)
       params.merge!(:api_key => Passtools.api_key )
-      response = RestClient.put(url, params, :multipart => true )
+      response = RestClient.put(url, params, headers.merge(:multipart => true) )
+      MultiJson.load(response)
+    end
+
+    def delete_request(path, params = {})
+      url = construct_url(path)
+      params.merge!(:api_key => Passtools.api_key )
+      response = RestClient.delete(url, headers.merge(:params => params))
       MultiJson.load(response)
     end
 
@@ -36,6 +43,11 @@ module Passtools
       Passtools.url + path
     end
 
+    def headers
+      { :user_agent => "passtools-gem-#{Passtools::VERSION}",
+        :accept => :json }
+    end
+
   end
 end
 

data/lib/passtools/template.rb

@@ -3,14 +3,18 @@ module Passtools
     extend Request
     attr_accessor :raw_data
 
-    def self.list
-      get("/template/headers")
+    def self.list(params={})
+      get("/template/headers", params)
     end
 
     def self.show(template_id)
       get("/template/#{template_id}")
     end
 
+    def self.delete(template_id)
+      delete_request("/template/#{template_id}")
+    end
+
     def self.build_from_current(template_id)
       begin
         response = show(template_id)
@@ -40,6 +44,19 @@ module Passtools
       fetch_from_raw('fieldsModel')
     end
 
+    def delete
+      return false unless self.id
+      response = self.class.delete_pass(id)
+      self.raw_data['id'] = nil if response['Status'] == 'Deleted'
+      response
+    end
+
+    def valid?
+      @raw_data.has_key?('fieldsModel')
+    end
+
+    protected 
+
     def fetch_from_raw(*args)
       data = @raw_data
       res = nil
@@ -47,9 +64,5 @@ module Passtools
       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.3.0"
+  VERSION = "0.4.3"
 end

data/spec/passtools/pass_spec.rb

@@ -45,6 +45,20 @@ describe 'Pass' do
     stub.should have_been_requested
   end
 
+  it "calls Passtools API to push Pass" do
+    stub = stub_write(:put, "http://foobar.com/pass/55/push")
+
+    Passtools::Pass.push(55)
+    stub.should have_been_requested
+  end
+
+  it "calls Passtools API to delete Pass" do
+    stub = stub_delete("http://foobar.com/pass/55" )
+
+    Passtools::Pass.delete(55)
+    stub.should have_been_requested
+  end
+
   it "raises descriptive error if directory does not exist when downloading" do
     Passtools.configure(:download_dir => "/asdfasdfasfd")
     expect {Passtools::Pass.download(55)}.to raise_error(RuntimeError, /Download directory is not defined or does not exist/)

data/spec/passtools/template_spec.rb

@@ -21,6 +21,13 @@ describe 'Template' do
     stub.should have_been_requested
   end
 
+  it "calls Passtools API to delete template" do
+    stub = stub_delete("http://foobar.com/template/55" )
+
+    Passtools::Template.delete(55)
+    stub.should have_been_requested
+  end
+
   context "The Template instance" do
     context 'when built from succesful api call' do
       before(:all) do

data/spec/support/passtools_helpers.rb

@@ -6,13 +6,20 @@ module PasstoolsHelpers
       to_return(:body => MultiJson.dump(body))
   end 
 
-  def stub_write(request_type, url, json)
+  def stub_write(request_type, url, json = nil)
+    body = {:api_key => 'i_am_an_api_key'}
+    body.merge!(:json => json) if json
     stub = stub_request(request_type, url).
-      with(:body => {:json => json, :api_key => 'i_am_an_api_key'},
+      with(:body => body,
            :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Multipart'=>'true'}).
       to_return(:body => "{}")
   end
 
+  def stub_delete(url,body={})
+    stub_request(:delete, url).
+      with(:query => {:api_key => 'i_am_an_api_key'}).
+      to_return(:body => MultiJson.dump(body))
+  end 
 
   def stub_error(url, error)
     stub_request(:get, url).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passtools
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client