passdock 0.1.5

data/Manifest

@@ -0,0 +1,4 @@
+Manifest
+README.md
+Rakefile
+lib/passdock.rb

data/README.md

@@ -0,0 +1,80 @@
+passdock-ruby
+=============
+
+Sample code to interact with Passdock API in ruby.
+
+### Dependancies
+
+This sample code requires *httparty*.
+
+Use 
+    
+    gem install httparty
+
+to istall them.
+
+### Get your authentication token
+
+You need to register on [api.passdock.com](https://api.passdock.com) and get an [api token](https://api.passdock.com/settings).
+
+### Let's start
+
+Once obtained you can create a new istance of the Passdock object.
+
+    passdock = Passdock.new("YOUR_TOKEN")
+
+Then you can call some methods to get the desired informations out of Passdock or to create new Passes.
+
+All the replies are JSON formatted text files.
+
+To get started just add one of the following line, appropriately modified at the bottom of the *passdock.rb* file.
+
+#### Get Templates
+
+Get all your templates for your account
+
+    pp passdock.templates
+    
+#### Get a Template
+
+Pass the id of the template as argument
+
+    pp passdock.template(82)
+
+#### Destroy a Template 
+
+The first argument is the template id, the second one if you want exanded errors.
+
+    pp passdock.destroy_template(82, true)
+
+#### Get a Pass
+
+The first parameter is the Pass ID, the second its template ID
+
+    pp passdock.pass(132, 82)
+
+#### Create a Pass
+
+The first argument is the a JSON jash containing the Pass structure, more informations on [api.passdock.com/doc](https://api.passdock.com/doc).
+The second argument is the template id, the third one if you want debug informations and the last one exanded errors.
+
+    pp passdock.create_pass('{"serial_number":"1234", "gate":"12"}', 82, true, false)
+
+#### Update a Pass
+
+The first argument is the a JSON jash containing the Pass structure, more informations on [api.passdock.com/doc](https://api.passdock.com/doc).
+The second argument is the template id, the third one if you want debug informations and the last one exanded errors.
+
+    pp passdock.update_pass('{"serial_number":"5678", "gate":"15"}', 94, 82, true, false)
+
+#### Download a Pass
+
+The first parameter is the Pass ID, the second its template ID
+
+    pp passdock.download_pass(82, 82)
+    
+#### Destroy a Pass 
+
+The first argument is the template id, the second one if you want exanded errors.
+
+    pp passdock.destroy_pass(94, 82, true)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('passdock', '0.1.5') do |p|
+  p.description     = "Talk with Passdock API"
+  p.url             = "http://github.com/Creapptor/passdock-ruby"
+  p.author          = "Creapptor S.A."
+  p.email           = "info@creapptor.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/passdock.rb

@@ -0,0 +1,89 @@
+gem 'httparty'
+
+module Passdock
+  include HTTParty
+  @@api_base = 'https://api.passdock.com/api/v1/'
+  @@api_key = nil
+  
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  def self.api_key
+    @@api_key
+  end
+  
+  def self.api_base=(api_base)
+    @@api_base = api_base
+  end
+
+  def self.api_base
+    @@api_base
+  end
+  
+  def self.templates
+    self.get("#{@@api_base}/templates?api_token=#{@@api_key}")
+  end
+  
+  def self.template(id)
+    self.get("#{@@api_base}/templates/#{id}?api_token=#{@@api_key}")
+  end
+  
+  def self.destroy_template(family_id, errors)
+    _errors = errors ? "true" : "false"
+    options = {
+      :body => {
+        :errors => _errors,
+        :api_token => @@api_key
+      }
+    }  
+    self.delete("#{@@api_base}/templates/#{family_id}", options)      
+  end 
+  
+  def self.pass(pass_id, family_id)
+    self.get("#{@@api_base}/templates/#{family_id}/passes/#{pass_id}?api_token=#{@@api_key}")
+  end
+  
+  def self.download_pass(pass_id, family_id)
+    self.get("#{@@api_base}/templates/#{family_id}/passes/#{pass_id}?api_token=#{@@api_key}&show=true")
+  end
+  
+  def self.create_pass(pass, family_id, debug, errors)
+    _debug = debug ? "true" : "false"
+    _errors = errors ? "true" : "false"
+    options = {
+      :body => {
+        :debug => _debug,
+        :errors => _errors,
+        :api_token => @@api_key,
+        :pass => pass
+      }
+    }  
+    self.post("#{@@api_base}/templates/#{family_id}/passes", options)      
+  end  
+  
+  def self.update_pass(pass, pass_id, family_id, debug, errors)
+    _debug = debug ? "true" : "false"
+    _errors = errors ? "true" : "false"    
+    options = {
+      :body => {
+        :debug => _debug,
+        :errors => _errors,
+        :api_token => @@api_key,
+        :pass => pass
+      }
+    }  
+    self.put("#{@@api_base}/templates/#{family_id}/passes/#{pass_id}", options)      
+  end  
+  
+  def self.destroy_pass(pass_id, family_id, errors)
+    _errors = errors ? "true" : "false"
+    options = {
+      :body => {
+        :errors => _errors,
+        :api_token => @@api_key
+      }
+    }  
+    self.delete("#{@@api_base}/templates/#{family_id}/passes/#{pass_id}", options)      
+  end    
+end

data/passdock.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "passdock"
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Creapptor S.A."]
+  s.date = "2012-09-19"
+  s.description = "Talk with Passdock API"
+  s.email = "info@creapptor.com"
+  s.extra_rdoc_files = ["README.md", "lib/passdock.rb"]
+  s.files = ["Manifest", "README.md", "Rakefile", "lib/passdock.rb", "passdock.gemspec"]
+  s.homepage = "http://github.com/Creapptor/passdock-ruby"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Passdock", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "passdock"
+  s.rubygems_version = "1.8.24"
+  s.summary = "Talk with Passdock API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: passdock
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+  prerelease: 
+platform: ruby
+authors:
+- Creapptor S.A.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-19 00:00:00.000000000 Z
+dependencies: []
+description: Talk with Passdock API
+email: info@creapptor.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- lib/passdock.rb
+files:
+- Manifest
+- README.md
+- Rakefile
+- lib/passdock.rb
+- passdock.gemspec
+homepage: http://github.com/Creapptor/passdock-ruby
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Passdock
+- --main
+- README.md
+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: '1.2'
+requirements: []
+rubyforge_project: passdock
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Talk with Passdock API
+test_files: []