icontact-api 0.2 → 0.3.0

data/Gemfile

@@ -0,0 +1,7 @@
+gem 'json'
+
+group :development do
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler'
+end
+

data/History.txt

@@ -1,8 +1,4 @@
-== 0.2 2009-07-20
-  * Modify authorization code to utilize new https based method
-
-== 0.1 2009-01-16
+== 0.0.1 2009-01-16
 
 * 1 major enhancement:
   * Initial release
-

data/{README.txt → README.rdoc}

@@ -39,11 +39,13 @@ 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.app_id = API_KEY
+    self.key = API_KEY
+    self.secret = API_SECRET
     self.domain = DOMAIN
   end
 end

data/Rakefile

@@ -1,29 +1,17 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+%w[rubygems rake rake/clean].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/icontact-api'
-require 'hoe'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'icontact-api' do |p|
-  p.version = Icontact::Api::VERSION
-  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'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "icontact-api"
+    gem.summary = %Q{A thin wrapper around the iContact API}
+    gem.authors = ["Kevin Olbrich"]
+    gem.email = ["kevin.olbrich+icontact-api@gmail.com"]
+    gem.homepage = "http://github.com/olbrich/IContact-API"
+	end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 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/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/icontact-api.rb

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

data/lib/icontact/api.rb

@@ -1,24 +1,25 @@
-require 'rubygems'
 require 'net/http'
 require 'net/https'
 require 'json'
 
 class Icontact
   class Api
-    VERSION = "0.2"
-    API_VERSION = "2.0"
-    DOMAIN = 'https://app.icontact.com/icp'
+    VERSION = "0.3"
+    API_VERSION = "2.2"
+    URL = 'https://app.icontact.com/icp'
     API_KEY = "API_KEY"
     attr_accessor :username
     attr_accessor :password
     attr_accessor :app_id
-    attr_accessor :domain
+    attr_accessor :url
+    attr_accessor :api_version
   
-    def initialize(username, password)
+    def initialize(username=nil, password=nil)
       self.username = username
       self.password = password
-      self.domain = DOMAIN
+      self.url = URL
       self.app_id = API_KEY
+      self.api_version = API_VERSION
     end
     
     # Package up any options into a query string and format it properly for the server
@@ -54,7 +55,7 @@ class Icontact
     # data exchange.  Also accepts text/xml for either, but then you have to deal with XML encoding and decoding
     # manually
     def apply_headers(req)
-      req.add_field('API-Version', API_VERSION)
+      req.add_field('API-Version', self.api_version)
       req.add_field('accept','application/json')
       req.add_field('Content-Type','application/json')
       req.add_field('API-Appid', self.app_id)
@@ -82,7 +83,7 @@ class Icontact
       # 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}")
+      full_url = URI.parse("#{self.url}#{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__)
@@ -93,6 +94,7 @@ class Icontact
     
       http = Net::HTTP.new(full_url.host, full_url.port)
       http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       response = http.start do |web|
         web.request(request)
       end

data/spec/api_spec.rb

@@ -1,16 +1,21 @@
 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_session = mock('http_session', :start=>@response, :use_ssl= => true)
-      Net::HTTP.stub!(:new).and_return(@mock_http_session)
+      @mock_http_request = mock('http', :request=>@response)
+      Net::HTTP.stub!(:start).and_yield(@mock_http_request)
     end
     
-    describe "an https request", :shared=>true do
+    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)
@@ -22,13 +27,8 @@ describe Icontact::Api do
         do_request(:limit=>10)
       end
       
-      it "should use ssl" do
-        @mock_http_session.should_receive(:use_ssl=).with(true)
-        do_request
-      end
-      
       it "should send the request" do
-        @mock_http_session.should_receive(:start)
+        Net::HTTP.should_receive(:start)
         do_request
       end
       
@@ -38,8 +38,8 @@ describe Icontact::Api do
       end      
     end
     
-    describe "an https request with a body", :shared=>true do
-      it_should_behave_like "an https request"
+    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)
@@ -53,7 +53,7 @@ describe Icontact::Api do
         @api.get("/a", options)
       end
       
-      it_should_behave_like "an https request"
+      it_should_behave_like "an http request"
     end
     
     describe ".post" do
@@ -61,7 +61,7 @@ describe Icontact::Api do
         @api.post("/a", {}, options)
       end
       
-      it_should_behave_like "an https request with a body"
+      it_should_behave_like "an http request with a body"
     end
     
     describe ".put" do
@@ -69,7 +69,7 @@ describe Icontact::Api do
         @api.put("/a", {}, options)
       end
       
-      it_should_behave_like "an https request with a body"
+      it_should_behave_like "an http request with a body"
     end
     
     describe '.delete' do
@@ -77,10 +77,25 @@ describe Icontact::Api do
         @api.delete("/a", options)
       end
       
-      it_should_behave_like "an https request"
+      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)
@@ -88,16 +103,16 @@ describe Icontact::Api do
     end
     
     def do_apply_headers
-      @api.apply_headers(@request)
+      @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)
+    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')
+      @request.should_receive(:add_field).with('ACCEPT', 'application/json')
       do_apply_headers      
     end
 
@@ -106,22 +121,31 @@ describe Icontact::Api do
       do_apply_headers      
     end
     
-    it "should add an API-AppId header to verify that our application is authrorized to use the API" do
-      @request.should_receive(:add_field).with('API-Appid', @api.class::API_KEY)
+    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')
+    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-Password header to verify that our user is authorized to use the API" do
-      @request.should_receive(:add_field).with('API-Password', 'password')
+  
+    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

metadata

@@ -1,84 +1,81 @@
 --- !ruby/object:Gem::Specification 
 name: icontact-api
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 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-----
+cert_chain: []
 
-date: 2009-07-20 00:00:00 -04:00
+date: 2011-04-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  name: json
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.3
-    version: 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: newgem
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.5.1
-    version: 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: hoe
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.2
-    version: 
-description: This gem provides a thin wrapper around the iContact 2.0 API.
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+description: 
 email: 
-- kevin.olbrich@gmail.com
+- kevin.olbrich+icontact-api@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 files: 
+- Gemfile
 - History.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
+- VERSION
 - lib/icontact-api.rb
 - lib/icontact/api.rb
 - script/console
@@ -89,33 +86,39 @@ files:
 - spec/spec_helper.rb
 - tasks/rspec.rake
 has_rdoc: true
-homepage: 
+homepage: http://github.com/olbrich/IContact-API
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: icontact-api
-rubygems_version: 1.3.4
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: This gem provides a thin wrapper around the iContact 2.0 API.
-test_files: []
-
+summary: A thin wrapper around the iContact API
+test_files: 
+- spec/api_spec.rb
+- spec/spec_helper.rb

data/Manifest.txt

@@ -1,13 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-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