snowshoe 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a07ff9e9a55e53f98d578f2788f56ba02e922ef1
+  data.tar.gz: 109b0185e8521586f708bd1b85ce59ea7c10b25f
+SHA512:
+  metadata.gz: 0f2e50575afce85c6d49ce797f5021a283585c645d4941b4f168c6dcce4d9bc38f2f46855daf008c6c8fa876bfe138b4f30219954ccd012731834afe72a4318c
+  data.tar.gz: d56acc52ac5b87ad4218093bb14473d8f0917cabb38b4e3862045ce3dbdebc9e256faabaa013786064988d686d18e2a182059de36c93acf3d58ed7b0e1cdfe6a

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*gem

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+== 2.0.0
+* Spring 2015 Release
+
+== 1.0.0
+* TechStars Disney Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Snowshoe
+
+MIT License
+
+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,70 @@
+Snowshoe API Ruby Client
+============
+
+The Snowshoe ruby client submits point data to the Snowshoe API for authentication. The client will return a JSON parsed hash, containing either  the serial of the matched stamp (a success!) or an error.
+
+## Dependencies
+- oauth
+
+## Installation
+```ruby
+gem install snowshoe
+```
+
+
+## Usage: Setting up the client and making a POST
+
+On instantiation of the Snowshoe client, pass in your SNOWSHOE_APP_KEY & SNOWSHOE_APP_SECRET, respectively.
+
+Currently, all posts are made to v2 of the API at http://beta.snowshoestamp.com/v2/stamp.
+
+The data hash is constructed from the point data sent by your front-end stamp screen.
+
+The client will return a JSON parsed hash, containing either the serial of the matched stamp (a success!) or an error.
+
+```ruby
+client = Snowshoe::Client.new(SNOWSHOE_APP_KEY, SNOWSHOE_APP_SECRET)
+data = { "data" => params["data"] }
+response = client.post(data)
+
+if response.include? "stamp"
+  # Serve success asset...
+else
+  # Handle errors...
+end
+```
+
+Below are examples of success and error JSON responses from the API.
+
+```javascript
+// Success
+{
+  "stamp": {
+    "serial": "DEV-STAMP"
+  },
+  "receipt": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+  "secure": false,
+  "created": "2015-03-24 11:27:33.014149"
+}
+
+// Error
+{
+  "error": {
+    "message": "Stamp not found",
+    "code": 32
+    },
+    "receipt": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+    "secure": false,
+    "created": "2015-03-24 11:27:48.235046"
+}
+```
+
+## Tests
+(Coming soon)
+
+
+## Contribute
+Join us in improving this client by making a pull request.
+
+## License
+MIT (see LICENSE file)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/snowshoe.rb

@@ -0,0 +1,5 @@
+require "oauth"
+require "json"
+
+require "snowshoe/client"
+require "snowshoe/version"

data/lib/snowshoe/client.rb

@@ -0,0 +1,39 @@
+module Snowshoe
+  class Client
+    API_VERSION = "http://beta.snowshoestamp.com/api/v2"
+
+    def initialize(key, secret, options={})
+      # Flexiblity for future endpoint uri changes
+      api_version = options[:api_version] || API_VERSION
+
+      @consumer = OAuth::Consumer.new(
+      key,
+      secret,
+      {:site => api_version,
+        :scheme => :header
+      }
+      )
+    end
+
+    def post(body)
+      response = consumer.request(:post,
+      "/stamp",
+      nil,
+      {},
+      body,
+      {'Content-Type' => 'application/x-www-form-urlencoded'}
+      )
+      return JSON.parse(response.body)
+    rescue => exception
+      log_error(exception.message)
+      []
+    end
+
+    def log_error(message)
+      puts "ERROR: #{self.class}: #{message}"
+    end
+
+    private
+    attr_reader :consumer
+  end
+end

data/lib/snowshoe/version.rb

@@ -0,0 +1,3 @@
+module Snowshoe
+  VERSION = "2.0.0"
+end

data/snowshoe.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snowshoe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snowshoe"
+  spec.version       = Snowshoe::VERSION
+  spec.summary       = %q{Ruby API Client for Snowshoe}
+  spec.description   = %q{Authenticate stamps from the Snowshoe API}
+  spec.license       = "MIT"
+  spec.authors       = ["Snowshoe","Iggy Igner", "Philipe Navarro"]
+  spec.email         = ["techteam@snowshoestamp.com"]
+  spec.homepage      = "http://snowshoestamp.com"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'oauth', '>= 0.4'
+end

data/test/client_test.rb

@@ -0,0 +1 @@
+# Coming soon.

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: snowshoe
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Snowshoe
+- Iggy Igner
+- Philipe Navarro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Authenticate stamps from the Snowshoe API
+email:
+- techteam@snowshoestamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/snowshoe.rb
+- lib/snowshoe/client.rb
+- lib/snowshoe/version.rb
+- snowshoe.gemspec
+- test/client_test.rb
+homepage: http://snowshoestamp.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Ruby API Client for Snowshoe
+test_files:
+- test/client_test.rb