MissionHub 1.0.1 → 2.0.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/ruby

data/Gemfile

@@ -1,4 +1,7 @@
 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/fixtures/vcr_cassettes/auth.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://www.missionhub.com/oauth/access_token
+    uri: http://stage.missionhub.com/oauth/access_token
     body:
       encoding: US-ASCII
       string: grant_type=none&client_id=12&client_secret=
@@ -15,7 +15,7 @@ http_interactions:
       Server:
       - nginx/1.0.14
       Date:
-      - Wed, 03 Oct 2012 23:29:16 GMT
+      - Thu, 08 Nov 2012 13:49:26 GMT
       Content-Type:
       - application/json
       Transfer-Encoding:
@@ -31,9 +31,9 @@ http_interactions:
       X-Ua-Compatible:
       - IE=Edge,chrome=1
       X-Request-Id:
-      - 7b1ff696190f4c801aff3c9d946d59ff
+      - 19536bac31ccee8569a1bdae781b7648
       X-Runtime:
-      - '0.004363'
+      - '0.123355'
       X-Rack-Cache:
       - invalidate, pass
     body:
@@ -41,13 +41,13 @@ http_interactions:
       string: ! '{"error":"invalid_client","error_description":"{\"error\": {\"message\":\"Client
         ID and client secret do not match.\", \"code\": \"52\"}}"}'
     http_version: 
-  recorded_at: Wed, 03 Oct 2012 23:28:06 GMT
+  recorded_at: Thu, 08 Nov 2012 13:47:09 GMT
 - request:
     method: post
-    uri: http://www.missionhub.com/oauth/access_token
+    uri: http://stage.missionhub.com/oauth/access_token
     body:
       encoding: US-ASCII
-      string: grant_type=none&client_id=12&client_secret=83f84763001c1fb4ce96adc4908b9ba285b510d6
+      string: grant_type=none&client_id=12&client_secret=33f84763tasf9c1fb4ce96adc4908b9ba285b510d0
     headers: {}
   response:
     status:
@@ -57,7 +57,7 @@ http_interactions:
       Server:
       - nginx/1.0.14
       Date:
-      - Wed, 03 Oct 2012 23:29:16 GMT
+      - Thu, 08 Nov 2012 13:49:27 GMT
       Content-Type:
       - application/json
       Transfer-Encoding:
@@ -73,24 +73,24 @@ http_interactions:
       X-Ua-Compatible:
       - IE=Edge,chrome=1
       Etag:
-      - ! '"5e899e87b14129ae3a0b4045e60aa034"'
+      - ! '"587793cf9f81936d3aa19ce565ea19cf"'
       X-Request-Id:
-      - 86584ba26c5eca90804362c68b672f07
+      - aae32e7e7ecd9ee631f7e24d277b0778
       X-Runtime:
-      - '0.012294'
+      - '0.047424'
       X-Rack-Cache:
       - invalidate, pass
     body:
       encoding: US-ASCII
-      string: ! '{"access_token":"e83b007f75ad49d480303f892de884204b7864bc817f0fb547c9d87444c39a75","scope":"contacts,userinfo,contact_assignment,followup_comments,roles,organization_info"}'
+      string: ! '{"access_token":"526bba947bfeb5a7d60206c75983dcf30aee5a68ef7bc7479c7a151cdce3c7e8","scope":"contacts,userinfo,contact_assignment,followup_comments,roles,organization_info"}'
     http_version: 
-  recorded_at: Wed, 03 Oct 2012 23:28:06 GMT
+  recorded_at: Thu, 08 Nov 2012 13:47:10 GMT
 - request:
     method: post
-    uri: http://www.missionhub.com/api/v2/contacts.json
+    uri: http://stage.missionhub.com/api/v2/contacts.json
     body:
       encoding: US-ASCII
-      string: person[firstName]=Test&person[lastName]=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][2]=C3&answers[4954][3]=C4&org_id=5522&user_id=1615180&access_token=e83b007f75ad49d480303f892de884204b7864bc817f0fb547c9d87444c39a75
+      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:
@@ -100,7 +100,7 @@ http_interactions:
       Server:
       - nginx/1.0.14
       Date:
-      - Wed, 03 Oct 2012 23:29:23 GMT
+      - Thu, 08 Nov 2012 13:49:28 GMT
       Content-Type:
       - application/json; charset=utf-8
       Transfer-Encoding:
@@ -114,49 +114,22 @@ http_interactions:
       X-Ua-Compatible:
       - IE=Edge,chrome=1
       Etag:
-      - ! '"74011cce4197da546e01a09a5e8ce450"'
+      - ! '"e081d0440636fc4cf4a95aa23fc06f6b"'
       Cache-Control:
       - max-age=0, private, must-revalidate
       Set-Cookie:
-      - _mh_session=09142d775c25a060139eb5fabbdf1320; path=/; expires=Fri, 05-Oct-2012
-        23:28:37 GMT; HttpOnly
+      - _mh_session=d3e7b5065853a46631c59b937c6674de; path=/; expires=Sat, 10-Nov-2012
+        13:50:24 GMT; HttpOnly
+      - logged_in=true; path=/
       X-Request-Id:
-      - cd61e19dd9bcef433ad39e1e8e8b02a6
+      - d27fa3266be6e14b41b311a106a38ee0
       X-Runtime:
-      - '5.300431'
+      - '0.195808'
       X-Rack-Cache:
       - invalidate, pass
     body:
       encoding: US-ASCII
-      string: ! '{"meta":{"request_time":1349306917},"id":"1050"}'
+      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: Wed, 03 Oct 2012 23:28:13 GMT
-- request:
-    method: post
-    uri: http://www.missionhub.com/api/v2/contacts.json
-    body:
-      encoding: US-ASCII
-      string: person[firstName]=Test&person[lastName]=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][]=&answers[4954][C3]=C3&answers[4954][C4]=C4&org_id=5522&user_id=1615180&access_token=e83b007f75ad49d480303f892de884204b7864bc817f0fb547c9d87444c39a75
-    headers: {}
-  response:
-    status:
-      code: 502
-      message: Bad Gateway
-    headers:
-      Server:
-      - nginx/1.0.14
-      Date:
-      - Wed, 10 Oct 2012 00:41:41 GMT
-      Content-Type:
-      - text/html
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '172'
-    body:
-      encoding: US-ASCII
-      string: ! "<html>\r\n<head><title>502 Bad Gateway</title></head>\r\n<body bgcolor=\"white\">\r\n<center><h1>502
-        Bad Gateway</h1></center>\r\n<hr><center>nginx/1.2.2</center>\r\n</body>\r\n</html>\r\n"
-    http_version: 
-  recorded_at: Wed, 10 Oct 2012 00:40:14 GMT
-recorded_with: VCR 2.2.5
+  recorded_at: Thu, 08 Nov 2012 13:47:11 GMT
+recorded_with: VCR 2.3.0

data/lib/missionhub.rb

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

data/lib/missionhub/base.rb

@@ -0,0 +1,40 @@
+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.proxy = proxy if proxy
+        @connection.auth_type = auth_type if auth_type
+        @connection.timeout = timeout if timeout
+        @connection
+      else
+        superclass.connection
+      end
+    end
+  end
+
+  class Connection < ActiveResource::Connection
+
+    private
+
+    def request(method, path, *arguments)
+      result = ActiveSupport::Notifications.instrument("request.active_resource") do |payload|
+        path = add_secret_to_path(path)
+        payload[:method]      = method
+        payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
+        payload[:result]      = http.send(method, path, *arguments)
+      end
+      handle_response(result)
+    rescue Timeout::Error => e
+      raise TimeoutError.new(e.message)
+    rescue OpenSSL::SSL::SSLError => e
+      raise SSLError.new(e.message)
+    end
+
+    def add_secret_to_path(path)
+      path += path.include?('?') ? '&' : '?'
+      path + "secret=#{MissionHub.client_secret}"
+    end
+  end
+end

data/lib/missionhub/email_address.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class EmailAddress < Base
+
+  end
+end

data/lib/missionhub/followup_comment.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class FollowupComment < Base
+
+  end
+end

data/lib/missionhub/organization.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class Organization < Base
+
+  end
+end

data/lib/missionhub/organizational_role.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class OrganizationalRole < Base
+
+  end
+end

data/lib/missionhub/person.rb

@@ -1,127 +1,5 @@
-require 'resolv'
-
 module MissionHub
-  class Person
-    attr_accessor :current_address_attributes, :phone_number, :email_address, :gender, :firstName, :lastName, :answers, :phone_number
-
-    #align variable naming with MissionHub API
-    alias :first_name= :firstName=
-    alias :first_name :firstName
-
-    alias :last_name= :lastName=
-    alias :last_name :lastName
-
-    alias :phone= :phone_number=
-    alias :phone :phone_number
-
-    alias :address :current_address_attributes
-
-    def phone=(phone)
-      raise "Phone must be a MissionHub::Person::Phone" unless phone.kind_of? MissionHub::Person::Phone
-      @phone_number = phone
-    end
-
-    def address=(address)
-      raise "Address must be a MissionHub::Person::Address" unless address.kind_of? MissionHub::Person::Address
-      @current_address_attributes = address
-    end
-
-    def set_answer(id, message)
-      if @answers.nil?
-        @answers = Hash.new
-      end
-
-      if message.is_a?(String) or message.is_a?(Hash) or message.is_a?(Array)
-        if id.is_a?(Integer)
-          if message.is_a?(Array)
-            h = {}
-            count = 0
-            message.each do |v|
-              h[count] = v
-              count += 1
-            end
-            message = h
-          end
-          @answers[id] = message
-        else
-          raise "Invalid type for id"
-        end
-      else
-        raise "Invalid type for message"
-      end
-    end
-
-    def get_answer(id)
-      @answers[id]
-    end
-
-    def current_address_attributes=(address)
-      raise "Address must be a MissionHub::Person::Address" unless address.kind_of? MissionHub::Person::Address
-      @current_address_attributes = address
-    end
-
-    def phone
-      @phone_number[:number]
-    end
-
-    def phone=(phone)
-      unless phone.empty?
-        @phone_number = {:number => phone.gsub(/[^0-9]/, ""), :primary => 0, :location => "mobile"}
-      else
-        raise "Phone appears to be empty"
-      end
-    end
-
-    def email_address
-      @email_address[:email]
-    end
-
-    def email_address=(email)
-      unless email.empty?
-        unless email =~ /^[a-zA-Z][\w\.-]*[a-zA-Z0-9]@[a-zA-Z0-9][\w\.-]*[a-zA-Z0-9]\.[a-zA-Z][a-zA-Z\.]*[a-zA-Z]$/
-            raise "Email does not appear to be valid format"
-        else
-            raise "Email domain name appears to be incorrect" unless validate_email_domain(email)
-            @email_address = {:email => email, :primary => 0}
-        end
-      else
-        raise "Email appears to be empty"
-      end
-    end
-
-    def gender=(gender)
-      if gender == "male" or gender == "female"
-        @gender = gender
-      else
-        raise "Gender must be either male or female"
-      end
-    end
-
-    def validate_email_domain(email)
-      domain = email.match(/\@(.+)/)[1]
-      Resolv::DNS.open do |dns|
-        @mx = dns.getresources(domain, Resolv::DNS::Resource::IN::MX)
-      end
-      @mx.size > 0 ? true : false
-    end
-
-    def full_name
-      @firstName + " " + @lastName
-    end
+  class Person < Base
 
-    def hash
-      hash_to_return = {}
-      self.instance_variables.each do |var|
-        temp = self.instance_variable_get(var)
-        if not temp.nil? and var.to_s != "@mx"
-          if temp.kind_of? MissionHub::Person::Address
-            hash_to_return[var.to_s.gsub("@","")] = temp.hash
-          else
-            hash_to_return[var.to_s.gsub("@","")] = temp
-          end
-        end
-      end
-      return hash_to_return
-    end
   end
 end

data/lib/missionhub/phone_number.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class PhoneNumber < Base
+
+  end
+end

data/lib/missionhub/question.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class Question < Base
+
+  end
+end

data/lib/missionhub/rejoicable.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class Rejoicable < Base
+
+  end
+end

data/lib/missionhub/role.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class Role < Base
+
+  end
+end

data/lib/missionhub/sms_keyword.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class SmsKeyword < Base
+
+  end
+end

data/lib/missionhub/survey.rb

@@ -0,0 +1,5 @@
+module MissionHub
+  class Survey < Base
+
+  end
+end

data/lib/missionhub/version.rb

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

data/missionhub.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/MissionHub/version', __FILE__)
+require File.expand_path('../lib/missionhub/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Tataihono Nikora"]
@@ -10,11 +10,11 @@ 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 "httparty", "~> 0.9.0"
+  #gem.add_dependency "activeresource", "~> 4.0.0.beta"
 
   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,7 +3,7 @@ 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://www.missionhub.com/'
+    MissionHub.base_uri.must_equal 'http://stage.missionhub.com/'
   end
 
   it "must have a defined client id" do

data/spec/spec_helper.rb

@@ -16,9 +16,9 @@ Turn.config do |c|
 end
 
 MissionHub.config do |c|
-  c.base_uri = 'http://www.missionhub.com/'
+  c.base_uri = 'http://stage.missionhub.com/'
   c.client_id = 12
-  c.client_secret = '83f84763001c1fb4ce96adc4908b9ba285b510d6'
+  c.client_secret = '33f84763tasf9c1fb4ce96adc4908b9ba285b510d0'
   c.org_id = 5522
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: MissionHub
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -43,22 +43,6 @@ 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
@@ -91,22 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.0
 description: Consume the MissionHub API easily with this Ruby Gem
 email:
 - tataihono.nikora@gmail.com
@@ -120,11 +88,19 @@ files:
 - README.md
 - Rakefile
 - fixtures/vcr_cassettes/auth.yml
-- lib/console.rb
 - lib/missionhub.rb
-- lib/missionhub/address.rb
-- lib/missionhub/api.rb
+- lib/missionhub/base.rb
+- lib/missionhub/email_address.rb
+- lib/missionhub/followup_comment.rb
+- lib/missionhub/organization.rb
+- lib/missionhub/organizational_role.rb
 - lib/missionhub/person.rb
+- lib/missionhub/phone_number.rb
+- lib/missionhub/question.rb
+- lib/missionhub/rejoicable.rb
+- lib/missionhub/role.rb
+- lib/missionhub/sms_keyword.rb
+- lib/missionhub/survey.rb
 - lib/missionhub/version.rb
 - missionhub.gemspec
 - spec/lib/missionhub/address_spec.rb

data/lib/console.rb

@@ -1,25 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '/missionhub.rb'))
-puts <<-TXT
-Ruby lib for working with the MissionHub API's JSON interface.
-The first thing you need to set is the Base URI for communicating
-with your MissionHub Instance.
-
-  MissionHub.base_uri = 'http://www.missionhub.com/'
-
-Then, you should set the authentication. You can find more info
-on API Authentication at http://wiki.uscm.org/display/NCO/Authentication.
-
-  #OAuth Two Legged Authentication
-  MissionHub.client_id = 1
-  MissionHub.client_secret = '32jk248bkjf0875sdasjloy'
-
-This library is a small wrapper around the REST interface.
-
-TXT
-
-MissionHub.config do |c|
-  # :outline  - turn's original case/test outline mode [default]
-  c.base_uri = 'http://www.missionhub.com/'
-  c.client_id = 6
-  c.client_secret = '5b1913aa85720d7ede99dac1ad35fbf40bbc4490d9da0df346877832469daeb2'
-end

data/lib/missionhub/address.rb

@@ -1,15 +0,0 @@
-module MissionHub
-  class Person
-    class Address
-      attr_accessor :address1, :address2, :city, :country, :state, :zip
-
-      def hash
-        hash_to_return = {}
-        self.instance_variables.each do |var|
-          hash_to_return[var.to_s.gsub("@","")] = self.instance_variable_get(var)
-        end
-        hash_to_return
-      end
-    end
-  end
-end

data/lib/missionhub/api.rb

@@ -1,43 +0,0 @@
-require 'yaml'
-require 'httparty'
-
-module MissionHub
-  class API
-    include HTTParty
-
-    @access_token = ''
-    @scope = Array[]
-
-    def initialize
-      self.class.base_uri MissionHub.base_uri
-    end
-
-    def auth
-      options = {:body => { :grant_type => 'none', :client_id => MissionHub.client_id, :client_secret => MissionHub.client_secret } }
-      response = self.class.post('/oauth/access_token', options)
-      raise 'invalid client' if response.parsed_response['access_token'].nil?
-      @access_token = response.parsed_response['access_token']
-      raise 'invalid scope' if response.parsed_response['scope'].nil?
-      @scope = response.parsed_response['scope'].split(',')
-      true
-    end
-
-    def create_person(person)
-      raise "Not Authenticated" if @access_token.nil?
-      raise "Scope doesn't allow for contact creation" unless @scope.include?("contacts")
-      raise "Peron must be a MissionHub::Person" unless person.kind_of? MissionHub::Person
-      raise "First name must be set to create person" if person.first_name.nil?
-
-      #hard_coded user_id (given by developer of API)
-      person_hash = person.hash
-      person_hash.delete("answers")
-      options = {:body => { :person => person_hash, :answers => person.answers, :org_id => MissionHub.org_id, :user_id => 1615180, :access_token => @access_token} }
-      response = self.class.post('/api/v2/contacts.json', options)
-      if !response.parsed_response['error'].nil?
-        raise response.parsed_response['error']
-      else
-        response
-      end
-    end
-  end
-end