MissionHub 2.0.0 → 2.1.0

data/Gemfile

@@ -1,7 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'activeresource', require: 'active_resource', git: 'git://github.com/rails/activeresource.git'
-gem 'activemodel', git: 'git://github.com/rails/rails.git'
-
 # Specify your gem's dependencies in missionhub.gemspec
 gemspec

data/Rakefile

@@ -7,4 +7,8 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+task :console do
+  sh "irb -rubygems -I lib -r missionhub.rb"
+end
+
 task :default => :test

data/lib/missionhub.rb

@@ -3,16 +3,8 @@ Dir[File.dirname(__FILE__) + '/missionhub/*.rb'].each do |file|
 end
 
 module MissionHub
+  extend Config
   class << self
-    attr_accessor :client_id, :client_secret, :site
 
-    # And we define a wrapper for the configuration block, that we'll use to set up
-    # our set of options
-    def config
-      yield self
-
-      self.site ||= "https://www.missionhub.com/apis/v3"
-      Base.site = site
-    end
   end
 end

data/lib/missionhub/base.rb

@@ -1,9 +1,9 @@
+require 'active_resource'
 module MissionHub
   class Base < ActiveResource::Base
-
     def self.connection(refresh = false)
       if defined?(@connection) || superclass == Object
-        @connection = Connection.new(site, format) if refresh || @connection.nil?
+        @connection = MissionHub::Connection.new(site, format) if refresh || @connection.nil?
         @connection.proxy = proxy if proxy
         @connection.auth_type = auth_type if auth_type
         @connection.timeout = timeout if timeout
@@ -33,8 +33,11 @@ module MissionHub
     end
 
     def add_secret_to_path(path)
-      path += path.include?('?') ? '&' : '?'
-      path + "secret=#{MissionHub.client_secret}"
+      unless path.include?('secret=')
+        path += path.include?('?') ? '&' : '?'
+        path += "secret=#{Thread.current["mission_hub.client_secret"]}"
+      end
+      path
     end
   end
 end

data/lib/missionhub/config.rb

@@ -0,0 +1,57 @@
+
+require 'missionhub/version'
+
+module MissionHub
+  # Defines constants and methods related to configuration
+  module Config
+
+
+    # The API Key if none is set
+    DEFAULT_CLIENT_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_SITE = 'https://www.missionhub.com/apis/v3'
+
+    # An array of valid keys in the options hash when configuring a {Twitter::Client}
+    VALID_OPTIONS_KEYS = [
+      :client_secret,
+      :site
+    ]
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    VALID_OPTIONS_KEYS.each do |attr|
+      define_method(attr) do
+        Thread.current["mission_hub.#{attr}"]
+      end
+
+      define_method("#{attr}=") do |val|
+        Thread.current["mission_hub.#{attr}"] = val
+      end
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def config
+      yield self
+      Base.site = Thread.current["mission_hub.site"]
+      self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.site               = DEFAULT_SITE
+      self
+    end
+  end
+end

data/lib/missionhub/version.rb

@@ -1,3 +1,3 @@
 module MissionHub
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/missionhub.gemspec

@@ -10,11 +10,12 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'webmock'
-  #gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'vcr'
   gem.add_development_dependency 'turn'
   gem.add_development_dependency 'rake'
 
-  #gem.add_dependency "activeresource", "~> 4.0.0.beta"
+  gem.add_dependency "activeresource"
+  gem.add_dependency "activemodel"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/lib/missionhub_spec.rb

@@ -3,19 +3,11 @@ require_relative '../spec_helper'
 describe MissionHub do
 
   it "must have the base url set to the MissionHub API" do
-    MissionHub.base_uri.must_equal 'http://stage.missionhub.com/'
-  end
-
-  it "must have a defined client id" do
-    MissionHub.client_id.wont_be_nil
+    MissionHub.site.must_equal 'https://www.missionhub.com/apis/v3'
   end
 
   it "must have a defined client secret" do
     MissionHub.client_secret.wont_be_empty
   end
 
-  it "must have a defined organization id" do
-    MissionHub.org_id.wont_be_nil
-  end
-
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 #we need the actual library file
-require_relative '../lib/missionhub'
+require_relative '../lib/MissionHub'
 #dependencies
 require 'minitest/autorun'
 require 'webmock/minitest'
@@ -16,17 +16,12 @@ Turn.config do |c|
 end
 
 MissionHub.config do |c|
-  c.base_uri = 'http://stage.missionhub.com/'
-  c.client_id = 12
-  c.client_secret = '33f84763tasf9c1fb4ce96adc4908b9ba285b510d0'
-  c.org_id = 5522
+  c.client_secret = '9d1211dfbd048192ef27047911a4554b10befb5deb870c85e15060ca9b8758f8'
 end
 
-#VCR config
-
 VCR.configure do |c|
   c.cassette_library_dir = 'fixtures/vcr_cassettes'
-  c.hook_into :webmock # or :fakeweb
+  c.hook_into :webmock
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: MissionHub
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Consume the MissionHub API easily with this Ruby Gem
 email:
 - tataihono.nikora@gmail.com
@@ -87,9 +135,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- fixtures/vcr_cassettes/auth.yml
 - lib/missionhub.rb
 - lib/missionhub/base.rb
+- lib/missionhub/config.rb
 - lib/missionhub/email_address.rb
 - lib/missionhub/followup_comment.rb
 - lib/missionhub/organization.rb
@@ -103,9 +151,6 @@ files:
 - lib/missionhub/survey.rb
 - lib/missionhub/version.rb
 - missionhub.gemspec
-- spec/lib/missionhub/address_spec.rb
-- spec/lib/missionhub/api_spec.rb
-- spec/lib/missionhub/person_spec.rb
 - spec/lib/missionhub/version_spec.rb
 - spec/lib/missionhub_spec.rb
 - spec/spec_helper.rb
@@ -134,9 +179,6 @@ signing_key:
 specification_version: 3
 summary: MissionHub API for Ruby
 test_files:
-- spec/lib/missionhub/address_spec.rb
-- spec/lib/missionhub/api_spec.rb
-- spec/lib/missionhub/person_spec.rb
 - spec/lib/missionhub/version_spec.rb
 - spec/lib/missionhub_spec.rb
 - spec/spec_helper.rb

data/fixtures/vcr_cassettes/auth.yml

@@ -1,135 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: http://stage.missionhub.com/oauth/access_token
-    body:
-      encoding: US-ASCII
-      string: grant_type=none&client_id=12&client_secret=
-    headers: {}
-  response:
-    status:
-      code: 400
-      message: Bad Request
-    headers:
-      Server:
-      - nginx/1.0.14
-      Date:
-      - Thu, 08 Nov 2012 13:49:26 GMT
-      Content-Type:
-      - application/json
-      Transfer-Encoding:
-      - chunked
-      Connection:
-      - keep-alive
-      Status:
-      - '400'
-      X-Powered-By:
-      - Phusion Passenger (mod_rails/mod_rack) 3.0.15
-      Cache-Control:
-      - no-store
-      X-Ua-Compatible:
-      - IE=Edge,chrome=1
-      X-Request-Id:
-      - 19536bac31ccee8569a1bdae781b7648
-      X-Runtime:
-      - '0.123355'
-      X-Rack-Cache:
-      - invalidate, pass
-    body:
-      encoding: US-ASCII
-      string: ! '{"error":"invalid_client","error_description":"{\"error\": {\"message\":\"Client
-        ID and client secret do not match.\", \"code\": \"52\"}}"}'
-    http_version: 
-  recorded_at: Thu, 08 Nov 2012 13:47:09 GMT
-- request:
-    method: post
-    uri: http://stage.missionhub.com/oauth/access_token
-    body:
-      encoding: US-ASCII
-      string: grant_type=none&client_id=12&client_secret=33f84763tasf9c1fb4ce96adc4908b9ba285b510d0
-    headers: {}
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx/1.0.14
-      Date:
-      - Thu, 08 Nov 2012 13:49:27 GMT
-      Content-Type:
-      - application/json
-      Transfer-Encoding:
-      - chunked
-      Connection:
-      - keep-alive
-      Status:
-      - '200'
-      X-Powered-By:
-      - Phusion Passenger (mod_rails/mod_rack) 3.0.15
-      Cache-Control:
-      - no-store
-      X-Ua-Compatible:
-      - IE=Edge,chrome=1
-      Etag:
-      - ! '"587793cf9f81936d3aa19ce565ea19cf"'
-      X-Request-Id:
-      - aae32e7e7ecd9ee631f7e24d277b0778
-      X-Runtime:
-      - '0.047424'
-      X-Rack-Cache:
-      - invalidate, pass
-    body:
-      encoding: US-ASCII
-      string: ! '{"access_token":"526bba947bfeb5a7d60206c75983dcf30aee5a68ef7bc7479c7a151cdce3c7e8","scope":"contacts,userinfo,contact_assignment,followup_comments,roles,organization_info"}'
-    http_version: 
-  recorded_at: Thu, 08 Nov 2012 13:47:10 GMT
-- request:
-    method: post
-    uri: http://stage.missionhub.com/api/v2/contacts.json
-    body:
-      encoding: US-ASCII
-      string: person[first_name]=Test&person[last_name]=User&person[gender]=female&person[current_address_attributes][address1]=123%20Somewhere%20St&person[current_address_attributes][address2]=Dept%202500&person[current_address_attributes][city]=Orlando&person[current_address_attributes][country]=US&person[current_address_attributes][state]=FL&person[current_address_attributes][zip]=32832&person[email_address][email]=mail%40google.com&person[email_address][primary]=0&person[phone_number][number]=021021021&person[phone_number][primary]=0&person[phone_number][location]=mobile&answers[4952]=Hello%20World&answers[4953]=R2&answers[4955]=D2&answers[4954][0]=&answers[4954][1]=C3&answers[4954][2]=C4&org_id=5522&user_id=1615180&access_token=526bba947bfeb5a7d60206c75983dcf30aee5a68ef7bc7479c7a151cdce3c7e8
-    headers: {}
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx/1.0.14
-      Date:
-      - Thu, 08 Nov 2012 13:49:28 GMT
-      Content-Type:
-      - application/json; charset=utf-8
-      Transfer-Encoding:
-      - chunked
-      Connection:
-      - keep-alive
-      Status:
-      - '200'
-      X-Powered-By:
-      - Phusion Passenger (mod_rails/mod_rack) 3.0.15
-      X-Ua-Compatible:
-      - IE=Edge,chrome=1
-      Etag:
-      - ! '"e081d0440636fc4cf4a95aa23fc06f6b"'
-      Cache-Control:
-      - max-age=0, private, must-revalidate
-      Set-Cookie:
-      - _mh_session=d3e7b5065853a46631c59b937c6674de; path=/; expires=Sat, 10-Nov-2012
-        13:50:24 GMT; HttpOnly
-      - logged_in=true; path=/
-      X-Request-Id:
-      - d27fa3266be6e14b41b311a106a38ee0
-      X-Runtime:
-      - '0.195808'
-      X-Rack-Cache:
-      - invalidate, pass
-    body:
-      encoding: US-ASCII
-      string: ! '{"id":2592834,"name":"Test User","assignment":{"assigned_to_person":[],"person_assigned_to":[]},"gender":"Female","status":"uncontacted","request_org_id":5522,"organizational_roles":[]}'
-    http_version: 
-  recorded_at: Thu, 08 Nov 2012 13:47:11 GMT
-recorded_with: VCR 2.3.0

data/spec/lib/missionhub/address_spec.rb

@@ -1,37 +0,0 @@
-require_relative '../../spec_helper'
-
-describe MissionHub::Person::Address do
-
-  let(:address) { MissionHub::Person::Address.new }
-
-  it "must be able to set address1" do
-    address.address1 = "71 Harrow Street"
-    address.address1.must_equal "71 Harrow Street"
-  end
-
-  it "must be able to set address2" do
-    address.address2 = "North Dunedin"
-    address.address2.must_equal "North Dunedin"
-  end
-
-  it "must be able to set city" do
-    address.city = "Dunedin"
-    address.city.must_equal "Dunedin"
-  end
-
-  it "must be able to set country" do
-    address.country = "NZ"
-    address.country.must_equal "NZ"
-  end
-
-  it "must be able to set state" do
-    address.state = "Otago"
-    address.state.must_equal "Otago"
-  end
-
-  it "must be able to set zip" do
-    address.zip = "9016"
-    address.zip.must_equal "9016"
-  end
-
-end

data/spec/lib/missionhub/api_spec.rb

@@ -1,93 +0,0 @@
-require_relative '../../spec_helper'
-
-describe MissionHub::API do
-
-  describe "Defaults" do
-
-    it "must include httparty methods" do
-      MissionHub::API.must_include HTTParty
-    end
-
-  end
-
-  describe "Authentication" do
-
-    let(:api) { MissionHub::API.new }
-
-    before do
-      VCR.insert_cassette 'auth', :record => :new_episodes, :match_requests_on => [:body]
-    end
-
-    after do
-      VCR.eject_cassette
-    end
-
-    it "must have a auth method" do
-      api.must_respond_to :auth
-    end
-
-    it "must throw exception when auth is incorrect" do
-      temp = MissionHub.client_secret
-      MissionHub.client_secret = ''
-
-      auth_error = lambda { api.auth }
-      auth_error.must_raise RuntimeError
-
-      MissionHub.client_secret = temp
-    end
-
-    it "must authenticate properly" do
-      api.auth.must_equal true
-    end
-  end
-
-  describe "Person" do
-
-    let(:api) { MissionHub::API.new }
-
-    before do
-      VCR.insert_cassette 'auth', :record => :new_episodes, :match_requests_on => [:body]
-      api.auth
-    end
-
-    after do
-      VCR.eject_cassette
-    end
-
-    it "must throw exception when person is wrong type" do
-      person_set_error = lambda { api.create_person('') }
-      person_set_error.must_raise RuntimeError
-    end
-
-    it "must throw exception when person has no name" do
-      person_set_error = lambda { api.create_person(MissionHub::Person.new) }
-      person_set_error.must_raise RuntimeError
-    end
-
-    it "must be able to create person" do
-      person = MissionHub::Person.new
-      person.first_name = "Test"
-      person.last_name = "User"
-      address = MissionHub::Person::Address.new
-      address.address1 = "123 Somewhere St"
-      address.address2 = "Dept 2500"
-      address.city = "Orlando"
-      address.country = "US"
-      address.state = "FL"
-      address.zip = "32832"
-      person.address = address
-      person.email_address = "mail@google.com"
-      person.gender = "female"
-      person.set_answer(4952, "Hello World")
-      person.set_answer(4953, "R2")
-      person.set_answer(4955, "D2")
-      hash_answer = {"2" => "C3", "3" => "C4"}
-      person.set_answer(4954, hash_answer)
-      array_answer = ["","C3","C4"]
-      person.set_answer(4954, array_answer)
-      person.phone = "021021021"
-      response = api.create_person(person)
-      response.must_be_instance_of Hash
-    end
-  end
-end

data/spec/lib/missionhub/person_spec.rb

@@ -1,95 +0,0 @@
-require_relative '../../spec_helper'
-
-describe MissionHub::Person do
-  let(:person) { MissionHub::Person.new }
-
-  describe "Set Address" do
-    it "must throw exception when address is wrong type" do
-      address_error = lambda { person.address = '' }
-      address_error.must_raise RuntimeError
-    end
-
-    it "must be able to set address" do
-      address = MissionHub::Person::Address.new
-      person.address = address
-      person.address.must_equal address
-    end
-  end
-
-  describe "Set Phone" do
-    it "must be able to set phone" do
-      person.phone = "078556821"
-      person.phone.must_equal "078556821"
-    end
-  end
-
-  describe "Set Email" do
-    it "must throw exception when email is empty" do
-      email_error = lambda { person.email_address = '' }
-      email_error.must_raise RuntimeError
-    end
-
-    it "must throw exception when email has invalid domain" do
-      email_error = lambda { person.email_address = 'mail@example.com' }
-      email_error.must_raise RuntimeError
-    end
-
-    it "must be able to set email" do
-      email = "mail@gmail.com"
-      person.email_address = email
-      person.email_address.must_equal email
-    end
-  end
-
-  describe "Set Gender" do
-    it "must throw exception when gender isn't male/female" do
-      gender_error = lambda { person.gender = 'not_gender' }
-      gender_error.must_raise RuntimeError
-    end
-
-    it "must be able to set gender to male" do
-      gender = "male"
-      person.gender = gender
-      person.gender.must_equal gender
-    end
-
-    it "must be able to set gender to female" do
-      gender = "female"
-      person.gender = gender
-      person.gender.must_equal gender
-    end
-  end
-
-  describe "Set Name" do
-    it "must be able to set first name" do
-      person.first_name = "First"
-      person.first_name.must_equal "First"
-    end
-
-    it "must be able to set last name" do
-      person.last_name = "Last"
-      person.last_name.must_equal "Last"
-    end
-
-    it "must be able to get full name" do
-      person.first_name = "First"
-      person.last_name = "Last"
-      person.full_name.must_equal "First Last"
-    end
-  end
-
-  describe "Set Answers" do
-    it "must be able to set survey answer" do
-      id = 1598
-      message = "true"
-      person.set_answer id, message
-      person.get_answer(id).must_equal message
-    end
-    it "must throw exception when answer is wrong type" do
-      id = 1598
-      message = 1
-      address_error = lambda { person.set_answer id, message }
-      address_error.must_raise RuntimeError
-    end
-  end
-end