tiptaplab 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjZhYTRmYTkxN2ZmNjU0M2MwMjMwNjUxNjA3MjY3YjRkNjljNTUyZQ==
+    ZjI3ZjQ2MjkxYjMwNWMwMWM2MWE4ZjkyMzE3NmYzOTFmM2I2MzRkNA==
   data.tar.gz: !binary |-
-    MWNmYjMzZGU1MGM3N2I5MjczZjZkMTlkMjU0MTE4ZjYyNWEyYmZjYg==
+    YjZmMmVlN2MzNWM0ODY4ZjVmODdkMjczYWQ0ZDQ0ODIwMjE1OTgzYw==
 SHA512:
   metadata.gz: !binary |-
-    MmJmOTZiNzkyNGNiY2ViMmRmZGVlZjQ4MDM4ZDFkOWE0YWMzOTExNzc0MjBj
-    OTgwYTk1MWQyNzc4NTk0ZmFkZDU0NjZjYzE2Yjk5YzEwODIwMzI4Mzc4MDBj
-    M2U4M2FiYWZlNWEyODUzMzA4NWY3YzA4YjAyYmU2MjAzOWU0Y2Q=
+    YTFiMGU1MWUyMjRiYTNhZjNmNjdlMGUwMWIwNzQ2NTcwNjA5YjdlNjhmNTc5
+    ZjM0MWUxYzI1ZTAzYzgxYzNmYTYyODUxZGY4NDYwOGY4MmZiZmU5NTM4N2U3
+    YTVhZmMwOWEwZDljMjRhYmI1ZThmNDc0ZjY4MTZlZDg1Mjc2MjM=
   data.tar.gz: !binary |-
-    MGRhN2JmOTdlNmMwOTUzMTQyNWI5MDBhNjNhNzY2NzhkZDBiNzhjZmIyOWNl
-    YzlhODIwOWMyNTEwYWNhYTA0MTU1ZWU3MTg0YzI3ZGFlYjgzMWI2MDExOGU4
-    NmJlYjNlY2NhZjU3MTQxYTM2MzAzNjRiZGU4NmRhMWUxOTY3YWE=
+    YTEyN2QyYTY4ZDdhMmYyY2ZiNzNiZDQ4N2I2NjcxYWQ5NTFhOWIzYjVlOTlm
+    NTIzYzczZTVkNmUwMTk3NmNjZTZiNWVlMDY4ZTU3NjMyYjg0YmJhNWFkODk2
+    NjU0ZjMxZDBhYWYxODlmOGMyNzA0NDY2NDNhNjM5OGUxZTFjYzk=

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    tiptaplab (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    i18n (0.6.5)
+    multi_json (1.7.9)
+    multipart-post (1.2.0)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2.11)
+  bundler (~> 1.3)
+  faraday (~> 0.8.8)
+  rake
+  rspec (~> 2.6)
+  tiptaplab!

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 TipTap
+
+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

@@ -1,6 +1,8 @@
 # Tiptaplab
 
-TODO: Write a gem description
+Warning: This gem is unfinished, and should not be used just yet.
+
+The tiptaplab gem will provide easy and painless access to the TipTapLab API.
 
 ## Installation
 
@@ -18,7 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, [register your application with the TipTapLab API][register]
+
+[register]https://api.tiptap.com/oauth/applications
+
+Then, create a new `Tiptaplab::Api` instance, specifying your `app_id` and `app_secret`:
+
+    api = Tiptaplab::Api.new(:app_id => YOUR_APP_ID, :app_secret => YOUR_APP_SECRET)
+
+In addition to the required app_id and app_secret, you can specify `:api_environment`. If this is set to 'staging', the gem will use the [TipTapLab staging API][staging]. This is useful while your app is in development, but remember that API data created on staging will not be available once you switch to production mode, and that your App credentials may be different.
+
+You can also make arbitrary calls to the api using the `make_call` method:
+
+    api.make_call(call_path, data, method)
+
+The default `data` is an empty hash and the default method is 'GET', so you can make simple requests with just the call path:
+
+    api.make_call('traits')
+    => [{"title"=>"Susceptability", "key"=>"susceptability"}, {"title"=>"Diet", "key"=>"diet"}...
+
 
 ## Contributing
 

data/lib/tiptaplab.rb

@@ -1,5 +1,9 @@
-require "tiptaplab/version"
-
 module Tiptaplab
-  # Your code goes here...
 end
+
+%w(
+  version
+  api
+  user
+  brand
+).each{|m| require File.dirname(__FILE__) + '/tiptaplab/' + m }

data/lib/tiptaplab/api.rb

@@ -0,0 +1,87 @@
+require 'active_support/core_ext/numeric'
+require 'faraday'
+require 'json'
+
+module Tiptaplab
+  class Api
+    DEFAULT_OPTIONS = {
+      :api_version => 3,
+      :api_environment => 'production'
+    }
+
+    def initialize *params
+      if params.first.is_a?(Hash)
+        hash_options = params.first
+        @api_version = hash_options[:api_version] || DEFAULT_OPTIONS[:api_version]
+        @api_environment = hash_options[:api_environment] || DEFAULT_OPTIONS[:api_environment]
+        @app_id = hash_options[:app_id]
+        unless @app_id
+          raise "No app_id specified. Please pass a Hash containing your application credentials to Tiptaplab::Api.new"
+        end
+        @app_secret = hash_options[:app_secret]
+        unless @app_secret
+          raise "No app_secret specified. Please pass a Hash containing your application credentials to Tiptaplab::Api.new"
+        end
+      else
+        raise "Pass init parameters as a Hash"
+      end
+      @version_str = "v#{@api_version}"
+      api_url = case @api_environment
+      when 'staging'
+        'http://api.staging.tiptap.com'
+      else
+        'https://api.tiptap.com'
+      end
+      @conn = Faraday.new(:url => api_url) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def fetch_auth_token(opts = {})
+      if opts[:force] || @auth_at.nil? || (@auth_at < (opts[:cache_for]|| 60.minutes).ago)
+        @auth_at = Time.now
+        token_response = @conn.post('/oauth/token',
+          {
+            :client_id => @app_id,
+            :client_secret => @app_secret,
+            :grant_type => 'client_credentials'
+          }
+        )
+        if token_response.status == 200
+          @auth_token = JSON.parse(token_response.body)['access_token']
+        else
+          raise "Error fetching auth token. Check the log for details."
+        end
+      end
+      @auth_token
+    end
+
+    def make_call(call, data = {}, method = 'GET')
+      fetch_auth_token
+      case method
+      when 'GET'
+        response = @conn.get("/#{@version_str}/#{call}", data, {'Authorization' => "Bearer #{@auth_token}"})
+        if response.status == '401'
+          puts "Response returned unauthorized, attempting to refresh auth token"
+          fetch_auth_token(:force => true)
+          response = @conn.get("/#{@version_str}/#{call}", data, {'Authorization' => "Bearer #{@auth_token}"})
+        end
+      when 'POST'
+        response = @conn.post("/#{@version_str}/#{call}", data, {'Authorization' => "Bearer #{@auth_token}"})
+        if response.status == '401'
+          puts "Response returned unauthorized, attempting to refresh auth token"
+          fetch_auth_token(:force => true)
+          response = @conn.get("/#{@version_str}/#{call}", data, {'Authorization' => "Bearer #{@auth_token}"})
+        end
+      end
+      if (response.status/100 == 2)
+        JSON.parse(response.body)
+      else
+        raise "Error making request. Status: #{response.status}. Check log for details."
+      end
+    end
+
+  end
+end

data/lib/tiptaplab/user.rb

@@ -0,0 +1,7 @@
+module Tiptaplab
+  class User
+    def create(params)
+      Tiptaplab::Api.call()
+    end
+  end
+end

data/lib/tiptaplab/version.rb

@@ -1,3 +1,3 @@
 module Tiptaplab
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/tiptaplab_spec.rb

@@ -0,0 +1 @@
+describe Tiptaplab

data/tiptaplab.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "activesupport", "~> 3.2.11"
+  spec.add_development_dependency "faraday", "~> 0.8.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiptaplab
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ian McLean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,48 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
 description: TipTapLab API Integration
 email:
 - engineering@tiptap.com
@@ -45,13 +87,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - Gemfile
+- Gemfile.lock
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/tiptaplab.rb
+- lib/tiptaplab/api.rb
+- lib/tiptaplab/brand.rb
+- lib/tiptaplab/user.rb
 - lib/tiptaplab/version.rb
+- pkg/tiptaplab-0.0.1.gem
+- spec/tiptaplab_spec.rb
 - tiptaplab.gemspec
 homepage: http://github.com/tiptapinc/tiptaplab
 licenses:
@@ -78,5 +126,6 @@ signing_key:
 specification_version: 4
 summary: Provides the ability to track and compare psychological trait information
   using the TipTapLab API.
-test_files: []
+test_files:
+- spec/tiptaplab_spec.rb
 has_rdoc: 

data/.gitignore

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