icontact-api 0.1 → 0.2

data/History.txt

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

data/Manifest.txt

@@ -1,6 +1,6 @@
 History.txt
 Manifest.txt
-README.rdoc
+README.txt
 Rakefile
 lib/icontact-api.rb
 lib/icontact/api.rb

data/{README.rdoc → README.txt}

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

data/Rakefile

@@ -1,9 +1,11 @@
 %w[rubygems rake rake/clean fileutils newgem rubigen].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.new('icontact-api', Icontact::Api::VERSION) do |p|
+$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

data/lib/icontact-api.rb

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

data/lib/icontact/api.rb

@@ -1,27 +1,24 @@
 require 'rubygems'
 require 'net/http'
-require 'digest'
+require 'net/https'
 require 'json'
 
 class Icontact
   class Api
-    VERSION = "0.1"
+    VERSION = "0.2"
     API_VERSION = "2.0"
-    DOMAIN = 'http://app.icontact.com/icp'
+    DOMAIN = 'https://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 :app_id
     attr_accessor :domain
   
     def initialize(username, password)
       self.username = username
       self.password = password
       self.domain = DOMAIN
-      self.key = API_KEY
-      self.secret = API_SECRET
+      self.app_id = API_KEY
     end
     
     # Package up any options into a query string and format it properly for the server
@@ -52,25 +49,17 @@ class Icontact
       {'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')
+    def apply_headers(req)
+      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))
+      req.add_field('API-Appid', self.app_id)
+      req.add_field('API-Username', self.username)
+      req.add_field('API-Password', self.password)
       return req
     end
   
@@ -98,15 +87,16 @@ class Icontact
       # 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)
-    
+      request = apply_headers(request)
       # 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  
+      http = Net::HTTP.new(full_url.host, full_url.port)
+      http.use_ssl = true
+      response = http.start do |web|
+        web.request(request)
+      end
+      return self.class.parse_response(response.code, response.body)
     end
   end
 end

data/spec/api_spec.rb

@@ -1,21 +1,16 @@
 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)
+
+      @mock_http_session = mock('http_session', :start=>@response, :use_ssl= => true)
+      Net::HTTP.stub!(:new).and_return(@mock_http_session)
     end
     
-    describe "an http request", :shared=>true do
+    describe "an https 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)
@@ -27,8 +22,13 @@ 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
-        Net::HTTP.should_receive(:start)
+        @mock_http_session.should_receive(:start)
         do_request
       end
       
@@ -38,8 +38,8 @@ describe Icontact::Api do
       end      
     end
     
-    describe "an http request with a body", :shared=>true do
-      it_should_behave_like "an http request"
+    describe "an https request with a body", :shared=>true do
+      it_should_behave_like "an https 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 http request"
+      it_should_behave_like "an https request"
     end
     
     describe ".post" do
@@ -61,7 +61,7 @@ describe Icontact::Api do
         @api.post("/a", {}, options)
       end
       
-      it_should_behave_like "an http request with a body"
+      it_should_behave_like "an https 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 http request with a body"
+      it_should_behave_like "an https request with a body"
     end
     
     describe '.delete' do
@@ -77,25 +77,10 @@ describe Icontact::Api do
         @api.delete("/a", options)
       end
       
-      it_should_behave_like "an http request"
+      it_should_behave_like "an https 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)
@@ -103,16 +88,16 @@ describe Icontact::Api do
     end
     
     def do_apply_headers
-      @api.apply_headers(:get, @request, 'http://fakeurl.com')
+      @api.apply_headers(@request)
     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
 
@@ -121,31 +106,22 @@ describe Icontact::Api do
       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)
+    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)
       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)
+    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_NUMBER header" do
-      @request.should_receive(:add_field).with('API_NUMBER', 111)
+
+    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')
       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,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: icontact-api
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Kevin Olbrich
@@ -30,7 +30,7 @@ cert_chain:
   4Umf0rf1f8h+GJia5xXYww==
   -----END CERTIFICATE-----
 
-date: 2009-03-24 00:00:00 -04:00
+date: 2009-07-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,7 +51,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.3
+        version: 1.5.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -61,7 +61,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 2.3.2
     version: 
 description: This gem provides a thin wrapper around the iContact 2.0 API.
 email: 
@@ -73,11 +73,11 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.rdoc
+- README.txt
 files: 
 - History.txt
 - Manifest.txt
-- README.rdoc
+- README.txt
 - Rakefile
 - lib/icontact-api.rb
 - lib/icontact/api.rb
@@ -90,10 +90,12 @@ files:
 - tasks/rspec.rake
 has_rdoc: true
 homepage: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
-- README.rdoc
+- README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -111,9 +113,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: icontact-api
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: This gem provides a thin wrapper around the iContact 2.0 API.
 test_files: []