icontact-api 0.1

data.tar.gz.sig

@@ -0,0 +1,3 @@
+.Ti?c}7y?x�I*�J-�U���|QE�kJ3g ZÆhIrh֠@�O���;����=C4H?3�
+��N�����2s,9��:{K�H�e�ӄ�N��|�f�Y'!4���&�֊.�2��DA�j��2H����'N�R����'區��]�ۆV�;3��\�����
+�*�]Do��9�i���`-k�*��bg��'��RDc�F�u0E��gM;k�=KpE�
b���҃QZ�	���2��ı

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-16
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/icontact-api.rb
+lib/icontact/api.rb
+script/console
+script/destroy
+script/generate
+spec/api_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,82 @@
+= icontact-api
+
+== DESCRIPTION:
+
+This gem provides a thin wrapper around the iContact 2.0 API.
+
+== FEATURES/PROBLEMS:
+
+* automatically signs each request
+* handles packing and unpacking into json
+* query params can be passed as an options hash
+
+== SYNOPSIS:
+
+Normally you will want to subclass the Icontact::Api class and define your API_KEY and API_SECRET, and optionally you may wish to hard-code a username and password for the API.
+
+@api = MyApi.new(username, password)
+@api.get('/a/000000/c/000000/messages', :limit=>10, :offset=>0)
+
+Please see the icontact developer documentation for a full listing of the supported resources and url structure.
+
+This gem is not officially supported by iContact.  Please contact the author with bug reports, feature requests, or questions about this gem.
+
+
+== REQUIREMENTS:
+
+* requires JSON gem
+
+== INSTALL:
+
+* sudo gem install icontact-api
+
+== USAGE
+
+for convenience create a class like this that keeps track of your API_KEY, API_SECRET, and optionally an api username and password:
+
+require 'icontact-api'
+class BetaApi < Icontact::Api
+  API_USERNAME='username'
+  API_PASSWORD='password'
+  API_KEY = 'YOUR_API_KEY'
+  API_SECRET = 'YOUR_API_SECRET'
+  DOMAIN = "http://app.beta.icontact.com/icp"
+
+  def initialize(username = BetaApi::API_USERNAME, password = BetaApi::API_PASSWORD)
+    super(username, password)
+    self.key = API_KEY
+    self.secret = API_SECRET
+    self.domain = DOMAIN
+  end
+end
+
+Then you can use it like:
+
+@api = BetaApi.new
+@api.get('/a')
+@api.post('/a/00000/c/0000/messages', data)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Kevin Olbrich
+
+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/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/icontact-api'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('icontact-api', Icontact::Api::VERSION) do |p|
+  p.developer('Kevin Olbrich', 'kevin.olbrich@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+     ['json','>= 1.1.3'],
+   ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/icontact-api.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'icontact/api'
+#require 'icontact-api/api'

data/lib/icontact/api.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'net/http'
+require 'digest'
+require 'json'
+
+class Icontact
+  class Api
+    VERSION = "0.1"
+    API_VERSION = "2.0"
+    DOMAIN = 'http://app.icontact.com/icp'
+    API_KEY = "API_KEY"
+    API_SECRET = "API_SECRET"
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :key
+    attr_accessor :secret
+    attr_accessor :domain
+  
+    def initialize(username, password)
+      self.username = username
+      self.password = password
+      self.domain = DOMAIN
+      self.key = API_KEY
+      self.secret = API_SECRET
+    end
+    
+    # Package up any options into a query string and format it properly for the server
+    # arrays become comma separated lists and Times are expressed as iso8601
+    def self.package_query_params(params={})
+      return nil if params.nil? || params.empty?
+      massaged_params = params.map do |key, value|
+        case value
+          when Array:
+            "#{key}=#{value.join(',')}"
+          when Time:
+            "#{key}=#{value.strftime("%Y-%m-%dT%H:%M:%S")}#{"%+0.2d:00" % (value.gmtoff / 3600)}"
+          else
+            "#{key}=#{value}"
+        end
+      end
+      "?#{massaged_params.join('&')}"
+    end
+  
+    # override this to use a different encoding method for sending data (like xml)
+    def self.body_encoder(data)
+      data.to_json
+    end
+  
+    # override this method to use a different response parser (like REXML for an xml response)
+    # when the response is not actually a JSON object an exception is thrown and the raw response is returned in the body instead.
+    def self.parse_response(code, response)
+      {'code'=>code, 'body' => (JSON.parse(response) rescue response)}
+    end
+  
+    def request_signature(method, timestamp, random, url)
+      Digest::SHA1.hexdigest("#{secret}#{password}#{timestamp}#{random}#{method.to_s.upcase}#{url}")
+    end
+  
+    # populate headers required by the icontact server on each request for authentication
+    # Accept and Content-Type are set to application/json to use JSON objects for the 
+    # data exchange.  Also accepts text/xml for either, but then you have to deal with XML encoding and decoding
+    # manually
+    def apply_headers(method, req, url)
+      timestamp = Time.now.getgm.to_i
+      random = Kernel.rand(999999)
+      req.add_field('API_VERSION', API_VERSION)
+      req.add_field('ACCEPT','application/json')
+      req.add_field('Content-Type','application/json')
+      req.add_field('API_KEY', self.key)
+      req.add_field('API_USERNAME', self.username)
+      req.add_field('API_TIMESTAMP', timestamp)
+      req.add_field('API_NUMBER', random)
+      req.add_field('API_SIGNATURE', request_signature(method, timestamp, random, url))
+      return req
+    end
+  
+    # dynamically create methods for get and delete.  These methods do not require a body to be sent
+    [:get, :delete].each do |meth|
+      define_method(meth) do |url, *options|
+        request(meth, url, nil, options)
+      end
+    end
+
+    # dynamically create methods for get and delete.  These methods require a body to be sent  
+    [:post, :put].each do |meth|
+      define_method(meth) do |url, data, *options|
+        request(meth, url, data, options)
+      end
+    end
+  
+    # Actually make the get, put, post, or delete request
+    def request(kind, url, data, options)
+      # options passed as optional parameter show up as an array
+      options = options.first if options.kind_of? Array
+      query_options = self.class.package_query_params(options)
+      full_url = URI.parse("#{self.domain}#{url}#{query_options}")
+    
+      # create an object of the class required to process this method
+      klass = Object.module_eval("::Net::HTTP::#{kind.to_s.capitalize}", __FILE__, __LINE__)
+      request = klass.new([full_url.path, full_url.query].compact.join('?'))
+      request = apply_headers(kind, request, full_url)
+    
+      # take passed data and encode it
+      request.body = self.class.body_encoder(data) if data
+    
+      Net::HTTP.start(full_url.host, full_url.port) do |http|
+        response = http.request(request)
+        return self.class.parse_response(response.code, response.body)
+      end  
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/icontact-api.rb'}"
+puts "Loading icontact-api gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/api_spec.rb

@@ -0,0 +1,177 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Icontact::Api do
+  before(:each) do
+    @mock_time = mock('Time', :getgm => 999999)
+    Time.stub!(:now).and_return(@mock_time)
+    Kernel.stub!(:rand).and_return(111)    
+  end
+
+  describe "api" do
+    before(:each) do
+      @api = Icontact::Api.new('mock_username', 'mock_password')
+      @response = mock('response',:code=>200, :body=>"body")
+      @mock_http_request = mock('http', :request=>@response)
+      Net::HTTP.stub!(:start).and_yield(@mock_http_request)
+    end
+    
+    describe "an http request", :shared=>true do
+      it "should apply headers to the request" do
+        @mock_request = mock("Request", :body= => true)
+        @api.should_receive(:apply_headers).and_return(@mock_request)
+        do_request
+      end
+    
+      it "should package query params" do
+        @api.class.should_receive(:package_query_params)
+        do_request(:limit=>10)
+      end
+      
+      it "should send the request" do
+        Net::HTTP.should_receive(:start)
+        do_request
+      end
+      
+      it "should parse the server response into a hash" do
+        @api.class.should_receive(:parse_response)
+        do_request
+      end      
+    end
+    
+    describe "an http request with a body", :shared=>true do
+      it_should_behave_like "an http request"
+      
+      it "should package the data into the body" do
+        @api.class.should_receive(:body_encoder)
+        do_request
+      end
+    end
+            
+    describe ".get" do
+      
+      def do_request(options={})
+        @api.get("/a", options)
+      end
+      
+      it_should_behave_like "an http request"
+    end
+    
+    describe ".post" do
+      def do_request(options={})
+        @api.post("/a", {}, options)
+      end
+      
+      it_should_behave_like "an http request with a body"
+    end
+    
+    describe ".put" do
+      def do_request(options={})
+        @api.put("/a", {}, options)
+      end
+      
+      it_should_behave_like "an http request with a body"
+    end
+    
+    describe '.delete' do
+      def do_request(options={})
+        @api.delete("/a", options)
+      end
+      
+      it_should_behave_like "an http request"
+    end
+  end
+
+  describe ".request_signature" do
+    before(:each) do
+      @api = Icontact::Api.new('username','password')
+      Kernel.stub!(:rand).and_return(111)
+      @mock_time = mock('Time', :getgm => 999999)
+      Time.stub!(:now).and_return(@mock_time)
+      Digest::SHA1.stub!(:hexdigest).and_return('api_signature')
+    end
+    
+    it "should generate an API Signature" do
+      Digest::SHA1.should_receive(:hexdigest).with('API_SECRETpasswordtimestamp/urlrandomGET').and_return('api_signature')
+      @api.request_signature('get','timestamp''/url', 'random', '').should == "api_signature"
+    end
+  end
+  
+  describe ".apply_headers" do
+    before(:each) do
+      @request = mock('Request', :add_field=>true)
+      @api = Icontact::Api.new('username','password')
+    end
+    
+    def do_apply_headers
+      @api.apply_headers(:get, @request, 'http://fakeurl.com')
+    end
+    
+    it "should add an API_VERSION header to indicate we are using the 2.0 version of the API" do
+      @request.should_receive(:add_field).with('API_VERSION', @api.class::API_VERSION)
+      do_apply_headers
+    end
+    
+    it "should add an ACCEPT header indicating we want a JSON object back" do
+      @request.should_receive(:add_field).with('ACCEPT', 'application/json')
+      do_apply_headers      
+    end
+
+    it "should add a Content-Type header indicating that passed data is JSON encoded" do
+      @request.should_receive(:add_field).with('Content-Type', 'application/json')
+      do_apply_headers      
+    end
+    
+    it "should add an API_KEY header to verify that our application is authrorized to use the API" do
+      @request.should_receive(:add_field).with('API_KEY', @api.class::API_KEY)
+      do_apply_headers      
+    end
+    
+    it "should add an API_USERNAME header to verify that our user is authorized to use the API" do
+      @request.should_receive(:add_field).with('API_USERNAME', 'username')
+      do_apply_headers      
+    end
+  
+    it "should add an API_TIMESTAMP header to prevent old requests from being replayed" do
+      @request.should_receive(:add_field).with('API_TIMESTAMP', 999999)
+      do_apply_headers      
+    end
+    
+    it "should add an API_NUMBER header" do
+      @request.should_receive(:add_field).with('API_NUMBER', 111)
+      do_apply_headers      
+    end
+
+    it "should add an API_SIGNATURE header to ensure this api request is valid" do
+      @api.should_receive(:request_signature).and_return('api_signature')
+      @request.should_receive(:add_field).with('API_SIGNATURE', 'api_signature')
+      do_apply_headers
+    end
+  end
+  
+  describe "class methods" do
+    it ".body_encoder should encode the data to be sent in JSON" do
+      data = {:messageIds=>[1,2,3,4,5]}
+      Icontact::Api::body_encoder(data).should == data.to_json
+    end
+
+    it ".parse_response should parse the JSON response into a hash" do
+      body = {:messageIds=>[1,2,3,4,5]}.to_json
+      Icontact::Api::parse_response(200, body).should == {"body"=>{"messageIds"=>[1, 2, 3, 4, 5]}, "code"=>200}
+    end
+  
+    describe ".package_query_params" do
+      # the "string".split('').sort trick is used because the string may come back in a different order each time because
+      # it is generated from an unordered hash, this trick allows comparison 
+      it "should package a hash into a query string according to the API requirements" do
+        options = {:limit=>10, :offset=>10, :messageId=>[1,2,3,4], :createdAt=>Time.at(1234567890)}
+        Icontact::Api::package_query_params(options).split('').sort.should == 
+          "?limit=10&messageId=1,2,3,4&createdAt=2009-02-13T18:31:30-05:00&offset=10".split('').sort
+      end
+      
+      it "should return nil if passed an empty hash" do
+        Icontact::Api::package_query_params({}).should be_nil
+      end
+    end
+    
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'icontact-api'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: icontact-api
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Kevin Olbrich
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPDCCAiSgAwIBAgIBADANBgkqhkiG9w0BAQUFADBEMRYwFAYDVQQDDA1rZXZp
+  bi5vbGJyaWNoMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wHhcNMDkwMzA3MTUwMzQ5WhcNMTAwMzA3MTUwMzQ5WjBEMRYwFAYDVQQD
+  DA1rZXZpbi5vbGJyaWNoMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJ
+  k/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvza3W
+  J5Dloirbhpge6teyZNfvOzuo478vtqnU/c6S8o2EerBkmWm88J+ipItO3U2HDPgP
+  a7THrx41/QEj1oG15mO6wtBLf0Z+AOJFAmf+Th8x3b46b3Voo1+suON67fCqCz+U
+  L5V2I5NBNywCte5Nzjh7knLkHr+rUCCKAIPK6vq+sASMIgmlhzZUuQfdRZMhRVZP
+  clMwf9sIp7LUTq2b/LCdP2dlGFydb1cyvaHjho+X/pk5uWKcr1OkrZtYFdxyeGU4
+  ZTtqEd5vaNTacYf0vGBfPfiolIfbmOa8Pgfyj8zkjBug/iukM/YGmwL1KAk8Qs+/
+  gInxSkyPxa7zkYTzAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0G
+  A1UdDgQWBBS+y2GRZjETz6d3jHKosqOZ6Ll+zjANBgkqhkiG9w0BAQUFAAOCAQEA
+  f3hCt6NBuESjAN4fkpbcfi3/Nj06aNl6CAfryfKaOaIfLcypT5nqP1qtqqGih5ne
+  QCe7jmtZHOGFC/SSlCS8obHSkCGn2cfUl/InfpF/YQnZV0Kp8esihuVmEjO0SgEU
+  yf46wW9Nh4byKctkgKMlWnIqwAyk4G1dD/le6MGJutb4pv5hT9qm1vaTFkAcy1Qu
+  1VMZa+MH6xnINGdFyV8T7AYL5BaQTbp2WYsfbOvy3ZfxbpP5O3wc3wter/Cyp8pu
+  Wvn0/+13roT+v5T5yFIpu6NbSpuqvRaKZvS+n2ZgwS10rUPFydzn+335umE4vsfH
+  4Umf0rf1f8h+GJia5xXYww==
+  -----END CERTIFICATE-----
+
+date: 2009-03-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: This gem provides a thin wrapper around the iContact 2.0 API.
+email: 
+- kevin.olbrich@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/icontact-api.rb
+- lib/icontact/api.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/api_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: icontact-api
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: This gem provides a thin wrapper around the iContact 2.0 API.
+test_files: []
+