passtools 0.2.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in passtools.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Tello, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# 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)
+
+## Installation
+
+Via rubygems.org:
+
+`$ gem install passtools`
+
+
+Using Bundler:
+
+Add this line to your application's Gemfile:
+
+`gem 'passtools'`
+
+And then execute:
+
+`$ bundle install`
+
+## Usage
+
+The gem must be configured before any calls can be successfully made. At the very least, the api_key is required and needs to be set. You can configure multiple values from a hash:
+
+`Passtools.configure(:api_key => 'i_am_an_api_key', :download_dir =
+"/tmp")`
+
+or from a yaml file:
+
+`Passtools.configure_from_file('config.yml')`
+
+You can also configure individual values directly via accessors:
+
+`Passtools.api_key = "i_am_an_api_key"`
+
+Once configured, there are 7 methods available to interact with the Passtools api. Returned JSON is parsed to provide Ruby data objects. 
+
+`Passtools::Template.list`
+
+Returns all templates associated with user specified by the api_key
+
+`Passtools::Template.show(template_id)`
+
+Returns detail information for individual template
+
+`Passtools::Pass.list`
+
+Returns list of all Passes associated with user
+
+`Passtools::Pass.show(pass_id)`
+
+Returns detail information for individual pass
+
+`Passtools::Pass.create(template_id, data)`
+
+Creates a new Pass based on specified template. Data is a nested hash containing data for
+fields, see data returned from the Pass.show call for structure. 
+
+`Passtools::Pass.update(pass_id, data)`
+
+Updates pass data
+
+`Passtools::Pass.download(pass_id)`
+
+Downloads Pass to the directory named by the 'download_dir'
+configuration value.  Passes are named 'PassToolsPass.pkpass'
+
+## 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.   
+
+Assuming you had a template with id 5 that returned the following from
+Passtools::Template.show(5)["fieldsModel"]
+
+```
+ {"first_name"=>
+     {"changeMessage"=>nil,
+     "fieldType"=>"PRIMARY",
+     "value"=>"John",
+     "label"=>"First Name",
+     "required"=>false},
+  "last_name"=>
+    {"changeMessage"=>nil,
+     "fieldType"=>"PRIMARY",
+     "value"=>"Doe",
+     "label"=>"Last Name",
+     "required"=>false}
+  }
+```
+
+You could create new Pass with:
+
+```
+data = {"first_name" => { "value" => "Abraham" }, 
+        "last_name" => { "value" => "Lincoln" } }
+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.  
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+
+desc 'pry console'
+task :console do
+  exec('bundle exec pry -I lib -r passtools.rb')
+end

data/lib/passtools.rb

@@ -0,0 +1,34 @@
+require "passtools/version"
+
+require 'rest_client'
+require 'multi_json'
+require 'yaml'
+
+require 'passtools/request'
+require 'passtools/template'
+require 'passtools/pass'
+
+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
+
+  def self.configure_from_file(pathname)
+    config = YAML::load(IO.read(pathname))
+    configure(config)
+  end
+
+  def self.url 
+    @url ||= 'https://api.passtools.com/v1'
+  end
+
+  def self.api_key
+    @api_key || raise("You must configure api_key before calling")
+  end
+
+end

data/lib/passtools/pass.rb

@@ -0,0 +1,33 @@
+module Passtools
+  class Pass
+    extend Request
+
+    def self.list
+      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}")
+    end
+    
+    def self.create(template_id,data)
+      json = MultiJson.dump(data)
+      post("/pass/#{template_id}", {:json => json } )
+    end
+
+    def self.update(pass_id,data)
+      json = MultiJson.dump(data)
+      put("/pass/#{pass_id}", { :json => json } )
+    end
+
+    def self.download(pass_id)
+      download_file("/pass/#{pass_id}/download", 'PassToolsPass.pkpass')
+    end
+
+  end
+
+end

data/lib/passtools/request.rb

@@ -0,0 +1,41 @@
+module Passtools
+  module Request
+
+    def get(path, params = {})
+      url = construct_url(path)
+      params.merge!(:api_key => Passtools.api_key)
+      response = RestClient.get(url, :params => params)
+      MultiJson.load(response)
+    end
+
+    def download_file(path, filename)
+      filepath = Pathname.new(Passtools.download_dir.to_s)
+      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)
+      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 )
+      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 )
+      MultiJson.load(response)
+    end
+
+    def construct_url(path)
+      raise "You must configure API url before calling" if Passtools.url.to_s.empty?
+      Passtools.url + path
+    end
+
+  end
+end
+

data/lib/passtools/template.rb

@@ -0,0 +1,15 @@
+module Passtools
+  class Template
+    extend Request
+
+    def self.list
+      get("/template/headers")
+    end
+ 
+
+    def self.show(template_id)
+      get("/template/#{template_id}")
+    end
+  end
+
+end

data/lib/passtools/version.rb

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

data/passtools.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/passtools/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Verba"]
+  gem.email         = ["david@halcyonengineering.com"]
+  gem.description   = %q{Ruby wrapper to access the Passtools API}
+  gem.summary       = %q{Passtools API gem}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "passtools"
+  gem.require_paths = ["lib"]
+  gem.version       = Passtools::VERSION
+
+  gem.add_dependency 'rest-client',  "~> 1.6.7"
+  gem.add_dependency 'multi_json', "~> 1.3.6"
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'fakefs'
+  
+end

data/spec/passtools/pass_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'fakefs/spec_helpers'
+
+describe 'Pass' do
+
+  include FakeFS::SpecHelpers
+  before(:each) do
+    Passtools.configure(:url => 'http://foobar.com',
+                        :api_key => 'i_am_an_api_key',
+                        :download_dir => '.')
+  end
+
+  it "calls Passtools API for list of Passes" do
+    stub = stub_get("http://foobar.com/pass")
+
+    Passtools::Pass.list
+    stub.should have_been_requested
+  end
+
+  it "calls Passtools API for individual Pass detail" do
+    stub = stub_get("http://foobar.com/pass/55")
+
+    Passtools::Pass.show(55)
+    stub.should have_been_requested
+  end
+
+  it "calls Passtools API to download 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"
+  end
+
+  it "calls Passtools API to create new Pass" do
+    stub = stub_write(:post, "http://foobar.com/pass/22", "{\"foo\":\"bar\"}" )
+
+    Passtools::Pass.create(22, {:foo => :bar })
+    stub.should have_been_requested
+  end
+
+  it "calls Passtools API to update new Pass" do
+    stub = stub_write(:put, "http://foobar.com/pass/55", "{\"foo\":\"bar\"}" )
+
+    Passtools::Pass.update(55, {:foo => :bar })
+    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/)
+  end
+
+  it "raises descriptive error if directory is not defined when downloading" do
+    Passtools.configure(:download_dir => nil)
+    expect {Passtools::Pass.download(55)}.to raise_error(RuntimeError, /Download directory is not defined or does not exist/)
+  end
+
+  it "raises error if url is empty" do
+    Passtools.configure(:url => '')
+    expect {Passtools::Pass.list}.to raise_error(RuntimeError, /You must configure API url before calling/)
+  end
+
+
+  it "raises error if api_key is not set" do
+    Passtools.configure(:api_key => nil)
+    expect {Passtools::Pass.list}.to raise_error(RuntimeError, /You must configure api_key before calling/)
+  end
+
+end

data/spec/passtools/template_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe 'Template' do  
+  before(:all) do
+    Passtools.configure(:url => 'http://foobar.com',
+                        :api_key => 'i_am_an_api_key')
+
+  end
+
+  it "calls Passtools API for list of template headers" do
+    stub = stub_get("http://foobar.com/template/headers")
+
+    Passtools::Template.list
+    stub.should have_been_requested
+  end
+
+  it "calls Passtools API for individual template detail" do
+    stub = stub_get("http://foobar.com/template/55")
+
+    Passtools::Template.show(55)
+    stub.should have_been_requested
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+
+#require 'bundler'
+#Bundler.setup
+
+require 'passtools'
+require 'webmock/rspec'
+require 'support/passtools_helpers'
+
+RSpec.configure do |config|
+  config.include PasstoolsHelpers
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/passtools_helpers.rb

@@ -0,0 +1,18 @@
+module PasstoolsHelpers
+
+  def stub_get(url, body='{}')
+    stub_request(:get, url).
+      with(:query => {:api_key => 'i_am_an_api_key'}).
+      to_return(:body => body)
+  end 
+
+  def stub_write(request_type, url, json)
+    stub = stub_request(request_type, url).
+      with(:body => {:json => json, :api_key => 'i_am_an_api_key'},
+           :headers => {'Content-Type'=>'application/x-www-form-urlencoded', 'Multipart'=>'true'}).
+      to_return(:body => "{}")
+  end
+
+end
+
+

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: passtools
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- David Verba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper to access the Passtools API
+email:
+- david@halcyonengineering.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/passtools.rb
+- lib/passtools/pass.rb
+- lib/passtools/request.rb
+- lib/passtools/template.rb
+- lib/passtools/version.rb
+- passtools.gemspec
+- spec/passtools/pass_spec.rb
+- spec/passtools/template_spec.rb
+- spec/spec_helper.rb
+- spec/support/passtools_helpers.rb
+homepage: ''
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Passtools API gem
+test_files:
+- spec/passtools/pass_spec.rb
+- spec/passtools/template_spec.rb
+- spec/spec_helper.rb
+- spec/support/passtools_helpers.rb