TwentyFourTru 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Cache Hamm
+
+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,42 @@
+# TwentyFourTru
+
+Ruby wrapper for 24Tru API, no frameworks required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'TwentyFourTru'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install TwentyFourTru
+
+## Usage
+```ruby
+TwentyFourTru::Client.token = 'jkfduisj97823974j2kl24899234'  #set api token
+
+@studies = TwentyFourTru::Study.all         #Load all studies you have access to
+@study = TwentyFourTru::Study.find(9999)    #Load single study
+
+@assignments = TwentyFourTru::Assignment.all(study_id)  #Load all assignments for the given study
+@assignment = TwentyFourTru::Assignment.find(assignment_id)  #Load assignment by the given id
+@new_assignment = TwentyFourTru::Assignment.create(STUDY_ID, {name: 'Assignment Name', text: 'Assignment Body'})
+
+@responses = TwentyFourTru::Assignment.all(assignment_id)  #Load all responses for the given assignment
+@response = TwentyFourTru::Assignment.find(response_id)  #Load response by the given id
+@new_text_response = TwentyFourTru::Response.create(ASSIGNMENT_ID, { "owner_id" => PARTICIPANT_ID, "title" => "Betty B. at the store", "text" => "I like to shop"})
+
+
+```
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TwentyFourTru.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'TwentyFourTru/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "TwentyFourTru"
+  gem.version       = TwentyFourTru::VERSION
+  gem.authors       = ["Cache Hamm"]
+  gem.email         = ["chamm@qualvu.com"]
+  gem.description   = %q{24Tru Api}
+  gem.summary       = %q{Login to 24tru.com/login and visit your profile to generate your api token}
+  gem.homepage      = ""
+  gem.add_development_dependency 'rspec', '~> 2.13.0'
+  gem.add_runtime_dependency 'rest-client', '~> 1.6.7'
+  gem.add_runtime_dependency 'json', '~> 1.8.0'
+
+  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.require_paths = ["lib"]
+end

data/lib/TwentyFourTru.rb

@@ -0,0 +1,10 @@
+require 'rest_client'
+require 'json'
+require "TwentyFourTru/version"
+require "TwentyFourTru/client.rb"
+require "TwentyFourTru/study.rb"
+require "TwentyFourTru/assignment.rb"
+require "TwentyFourTru/response.rb"
+
+module TwentyFourTru
+end

data/lib/TwentyFourTru/assignment.rb

@@ -0,0 +1,20 @@
+module TwentyFourTru
+  class Assignment
+
+    class << self
+      def all(study_id, options={})
+        Client.get("/studies/#{study_id}/assignments")
+      end
+
+      def find(assignment_id)
+        Client.get("/assignments/#{assignment_id}")
+      end
+
+      def create(study_id, options)
+        Client.post("/studies/#{study_id}/assignments", options)
+      end
+    end
+
+    attr_accessor :study_id, :assignment_id
+  end
+end

data/lib/TwentyFourTru/client.rb

@@ -0,0 +1,80 @@
+module TwentyFourTru
+
+  class Client
+
+    class NoToken < StandardError; end
+
+    class << self
+      attr_writer :use_ssl, :token, :api_host
+
+      def use_ssl
+        @use_ssl || false
+      end
+
+      # this is your connection for the entire module
+      def connection(options={})
+        raise NoToken if @token.to_s.empty?
+
+        @connections ||= {}
+
+        cached_connection? && !protocol_changed? ? cached_connection : new_connection
+      end
+
+      def get(url)
+        JSON.parse(RestClient.get "#{use_ssl ? api_ssl_url : api_url}" + url, :params => {:auth_token => @token}, :content_type => :json)
+      end
+
+      def post(url, options)
+        options.merge!({:auth_token => @token})
+        JSON.parse(RestClient.post "#{use_ssl ? api_ssl_url : api_url}" + url, options, :content_type => :json)
+      end
+
+      def clear_connections
+        @connections = nil
+      end
+
+      def api_host
+        @api_host ||= "www.24tru.com"
+      end
+
+      def api_ssl_url
+        "https://#{api_host}#{api_path}"
+      end
+
+      def api_url
+        "http://#{api_host}#{api_path}"
+      end
+
+      protected
+
+        def protocol
+          use_ssl ? 'https' : 'http'
+        end
+
+        def cached_connection?
+          !@connections[@token].nil?
+        end
+
+        def cached_connection
+          @connections[@token]
+        end
+
+        def new_connection
+          @connections[@token] = RestClient::Resource.new("#{use_ssl ? api_ssl_url : api_url}", :params => {auth_token: @token}, :headers => {'X-TrackerToken' => @token, 'Content-Type' => 'application/xml'})
+        end
+
+        def protocol_changed?
+          cached_connection? ? (cached_connection_protocol != protocol) : false
+        end
+
+        def cached_connection_protocol
+          cached_connection.url.match(/^(.*):\/\//).captures.first
+        end
+
+        def api_path
+          '/r/api/v2'
+        end
+    end
+
+  end
+end

data/lib/TwentyFourTru/response.rb

@@ -0,0 +1,20 @@
+module TwentyFourTru
+  class Response
+
+    class << self
+      def all(assignment_id, options={})
+        Client.get("/assignments/#{assignment_id}/responses")
+      end
+
+      def find(response_id)
+        Client.get("/responses/#{response_id}")
+      end
+
+      def create(assignment_id, options)
+        Client.post("/assignments/#{assignment_id}/responses", options)
+      end
+    end
+
+    attr_accessor :assignment_id, :response_id
+  end
+end

data/lib/TwentyFourTru/study.rb

@@ -0,0 +1,17 @@
+module TwentyFourTru
+  class Study
+
+    class << self
+      def all(options={})
+        Client.get("/studies")
+      end
+
+      def find(study_id)
+        Client.get("/studies/#{study_id}")
+      end
+    end
+
+    attr_accessor :study_id
+
+  end
+end

data/lib/TwentyFourTru/version.rb

@@ -0,0 +1,3 @@
+module TwentyFourTru
+  VERSION = "0.0.1"
+end

data/spec/assignment_spec.rb

@@ -0,0 +1,18 @@
+require 'TwentyFourTru'
+require_relative 'spec_helper'
+
+describe TwentyFourTru::Assignment do
+  it 'should be able load all assignments for a study' do
+    TwentyFourTru::Assignment.all(STUDY_ID).should be_a(Array)
+  end
+
+  it 'should be able to load a single assignment' do
+    TwentyFourTru::Assignment.find(ASSIGNMENT_ID).should be_kind_of(Hash)
+  end
+
+  it 'should be able to create new assignments' do
+    response = TwentyFourTru::Assignment.create(STUDY_ID, {name: 'Assignment Name', text: 'Assignment Body'})
+    expected_keys = ['id', 'name', 'text', 'url', 'video_url', 'responses_url']
+    expected_keys.each { |key| response.should have_key(key) }
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,9 @@
+require 'TwentyFourTru'
+
+describe TwentyFourTru::Client do
+  it 'should be able to connect to the api' do
+    obj = Object.new
+    TwentyFourTru::Client.stub(:new_connection).and_return(obj)
+    TwentyFourTru::Client.connection.should eql(obj)
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,22 @@
+require 'TwentyFourTru'
+require_relative 'spec_helper'
+
+describe TwentyFourTru::Response do
+  it 'should be able load all responses for an assignment' do
+    TwentyFourTru::Response.all(ASSIGNMENT_ID).should be_a(Array)
+  end
+
+  it 'should be able to load a single response' do
+    TwentyFourTru::Response.find(RESPONSE_ID).should be_kind_of(Hash)
+  end
+
+  it 'should be able to create new text responses' do
+    response = TwentyFourTru::Response.create(ASSIGNMENT_ID, {"owner_id" => PARTICIPANT_ID, "title" => "Betty B. at the store", "text" => "this is awesome"})
+    expected_keys = ['id', 'name', 'owner', 'insert_dt', 'url', 'video_url', 'mobile_video_url', 'thumbnail_url']
+    expected_keys.each { |key| response.should have_key(key) }
+
+    response['thumbnail_url'].should match('text_response_default')
+    response['owner'].should have_key('name')
+    response['owner'].should have_key('avatar_url')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+
+STUDY_ID = 3571
+ASSIGNMENT_ID = 21410
+RESPONSE_ID = 460688
+PARTICIPANT_ID = 48651
+
+TwentyFourTru::Client.token = 'hcZxQq5bEKndMzbgaqow'
+TwentyFourTru::Client.api_host = 'web1.24tru.dev'

data/spec/study_spec.rb

@@ -0,0 +1,12 @@
+require 'TwentyFourTru'
+require_relative 'spec_helper'
+
+describe TwentyFourTru::Study do
+  it 'should be able to load a single study' do
+    TwentyFourTru::Study.find(STUDY_ID).should be_a(Object)
+  end
+
+  it 'should be able load all studies' do
+    TwentyFourTru::Study.all.should be_a(Array)
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: TwentyFourTru
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cache Hamm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: 24Tru Api
+email:
+- chamm@qualvu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TwentyFourTru.gemspec
+- lib/TwentyFourTru.rb
+- lib/TwentyFourTru/assignment.rb
+- lib/TwentyFourTru/client.rb
+- lib/TwentyFourTru/response.rb
+- lib/TwentyFourTru/study.rb
+- lib/TwentyFourTru/version.rb
+- spec/assignment_spec.rb
+- spec/client_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/study_spec.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.25
+signing_key: 
+specification_version: 3
+summary: Login to 24tru.com/login and visit your profile to generate your api token
+test_files:
+- spec/assignment_spec.rb
+- spec/client_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/study_spec.rb