agecheq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4dd4472984464ddcb34687ac16ad7ae40be825c
+  data.tar.gz: 53ae5262a0baf1de56181a5e3d1563d2f31d1d70
+SHA512:
+  metadata.gz: 2d742d62881f58f2ef3dc34c6ac2141fb80ded5f39c5914326a85236d86619b0fef93f186988fede593171f6320f9fcf666894b11dc5f02238c862e1739b13a8
+  data.tar.gz: 56389b3bd1a1240b0cd38a89ced2e7b3c48bed7b1d54723a39c74b50ada4efdb6a6572b32b83262fbaed24e51d438160b3e775bd1106d82ba11f4ac76e72e944

data/README.md

@@ -0,0 +1,48 @@
+# AgeCheq API Client for Ruby
+
+This is a simple [HTTParty](http://johnnunemaker.com/httparty/) wrapper around the [AgeCheq](http://www.agecheq.com/) API.
+
+## Installation
+
+Add `agecheq` to your Gemfile.
+
+```ruby
+gem 'agecheq'
+```
+
+## Usage
+
+You must first configure the gem with your developer key and application id. Both can be obtained from the [AgeCheq Developer Dashboard](http://developer.agecheq.com/).
+
+```ruby
+AgeCheq.configure do |config|
+  config.api_key = "ABCD"
+  config.application_id = "XYZ"
+end
+```
+
+### Status Check
+
+Check the status of an AgeCheq PIN and your application using:
+
+```ruby
+AgeCheq::Child.check('AGECHEQ_PIN')
+OR
+child = AgeCheq::Child.new('AGECHEQ_PIN')
+child.status
+```
+
+### Associate Data
+
+Associate data with an AgeCheq PIN and your application using:
+
+```ruby
+AgeCheq::Child.associate('AGECHEQ_PIN', 'DATA')
+OR
+child = AgeCheq::Child.new('AGECHEQ_PIN')
+child.associate('DATA')
+```
+
+## Testing
+
+Testing is done with RSpec and executed using `bundle exec rspec`.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Quirkyapi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/agecheq.rb

@@ -0,0 +1,19 @@
+require 'httparty'
+
+require 'agecheq/configuration'
+require 'agecheq/version'
+require 'agecheq/child'
+
+module AgeCheq
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset!
+    @configuration = Configuration.new
+  end
+end

data/lib/agecheq/child.rb

@@ -0,0 +1,46 @@
+require 'agecheq/response_parser'
+
+module AgeCheq
+  class Child
+    include HTTParty
+
+    format :json
+    parser ResponseParser
+
+    # Shortcut methods for initializing and making an API call in one line.
+    class << self
+      def check(pin)
+        self.new(pin).check
+      end
+
+      def associate(pin, data)
+        self.new(pin).associate(data)
+      end
+
+      def configure!
+        raise 'You must set the api_key and application_id using configure' unless AgeCheq.configuration.configured?
+        basic_auth AgeCheq.configuration.api_key, ' '
+        base_uri 'https://api.agecheq.com/applications/' + AgeCheq.configuration.application_id
+      end
+    end
+
+    attr_reader :pin
+
+    def initialize(pin)
+      @pin = pin
+      self.class.configure!
+    end
+
+    # Check the status of a child using their pin.
+    def check
+      response = self.class.get("/acpin/#{@pin}/check")
+      response.parsed_response
+    end
+
+    # Associate some data with a child's account.
+    def associate(data)
+      response = self.class.get("/acpin/#{@pin}/associate/#{data}")
+      response.parsed_response
+    end
+  end
+end

data/lib/agecheq/configuration.rb

@@ -0,0 +1,17 @@
+require 'active_support/core_ext/object/blank'
+
+module AgeCheq
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :application_id
+
+    def initialize
+      @api_key = ""
+      @application_id = ""
+    end
+
+    def configured?
+      !api_key.blank? && !application_id.blank?
+    end
+  end
+end

data/lib/agecheq/response_parser.rb

@@ -0,0 +1,27 @@
+require 'active_support/hash_with_indifferent_access'
+
+module AgeCheq
+  InvalidCommand = Class.new(StandardError)
+  InvalidAgeCheqPin = Class.new(StandardError)
+  UnknownFailure = Class.new(StandardError)
+
+  class ResponseParser < HTTParty::Parser
+    def parse
+      response = JSON.parse(body)
+
+      # Check for a failure response.
+      if response['rtn'] == 'fail'
+        if response['rtnmsg'] == 'invalid command'
+          raise InvalidCommand, response['rtnmsg']
+        elsif response['rtnmsg'] == 'invalid child agecheq pin'
+          raise InvalidAgeCheqPin, response['rtnmsg']
+        else
+          raise UnknownFailure, response['rtnmsg']
+        end
+      end
+
+      # Return data as a HWIA.
+      ActiveSupport::HashWithIndifferentAccess.new(response['data'])
+    end
+  end
+end

data/lib/agecheq/version.rb

@@ -0,0 +1,3 @@
+module AgeCheq
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: agecheq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Quirky Development
+- Adam Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: AgeCheq is a thin Ruby wrapper around the AgeCheq API.
+email:
+- platform@quirky.com
+- amichel@quirky.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/agecheq.rb
+- lib/agecheq/child.rb
+- lib/agecheq/configuration.rb
+- lib/agecheq/response_parser.rb
+- lib/agecheq/version.rb
+homepage: https://www.quirky.com
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: AgeCheq is a thin Ruby wrapper around the AgeCheq API.
+test_files: []