getresponse 0.1.1 → 0.2

data/README.rdoc

@@ -1,6 +1,8 @@
 == GetResponse
 
-Wrapper for GetResponse API
+Wrapper for GetResponse API.
+Class interfaces from version 0.2 has changed breaking backward compatibility.
+Be sure to check changes before update.
 
 == Usage
 
@@ -9,42 +11,25 @@ Test connection to GetResponse API.
   gr_connection = GetResponse::Connection.new("my_secret_api")
   gr_connection.ping
 
-Get info about account
+Get info about account:
 
-  gr_connection.get_account_info
+  gr_connection.account
 
-Get yout active campaings. More info about operators http://dev.getresponse.com/api-doc/#operators
+Get your active campaigns.
 
-  # get campaings with name "My campaing name"
-  gr_connection.get_campaings(:name.is_eq => "My campaing name")
-
-  # get campaings with other name than "My campaing name"
-  gr_connection.get_campaings(:name.is_not_eq => "My campaing name")
-
-  # get campaings with name like "signup" and with from_email with domain "mybiz.xx"
-  gr_connection.get_campaigns(:name.contain => "%signup%", :from_email.contain => "%mybiz.xx"
-
-Get single campaign
-
-  gr_connection.get_campaign(123456)
-  => <#GetResponse::Campaign ... >
-
-  gr_connection.get_campaign(bad_id)
-  => nil
+  gr_connection.campaigns.all
 
 You can operate on your contacts quite the same way as on ActiveRecord objects. Before any operation
 on contacts you must connect to API.
 
 Get all contacts:
 
-  # connect to API
-  GetResponse::Connection.instance("my_secret_api_key")
-  GetResponse::Contact.find_all
+  gr_connection.contacts.all
 
 Create new contact:
 
   # with connection
-  GetResponse::Contact.create("name" => "John Doe", "email" => "john.d@somewhere.com",
+  gr_connection.contacts.create("name" => "John Doe", "email" => "john.d@somewhere.com",
     "campaign" => "campaignId", "customs" => { "source" => "mainpage" })
 
 Update your contact:
@@ -53,6 +38,10 @@ Update your contact:
   # contact - existing contact
   contact.update("name" => "John Thenewname")
 
+  # or
+  contact.name = "John Thenewname"
+  contact.save
+
 Delete contact:
 
   # with connection
@@ -77,18 +66,4 @@ Set contact cycle
 
   # with connection
   # contact - existing contact
-  contact.set_cycle(5)
-
-Get messages in account:
-
-  # get messages assigned to campaign with "N3i" ID
-  gr_connection.get_messages(:campaigns => ["N3i"])
-
-  # get messages with newsletter type
-  gr_connection.get_messages(:type => "newsletter")
-
-  # get messages from from campaigns with name like "my_biz"
-  gr_connection.get_messages(:get_campaigns => { :name.contain => "%my_biz%" })
-
-  # get one messages identifier by <tt>id</tt>
-  gr_connection.get_message("some_id")
+  contact.set_cycle(5)

data/lib/get_response.rb

@@ -47,4 +47,6 @@ GetResponse.autoload :Account, "get_response/account"
 GetResponse.autoload :Campaign, "get_response/campaign"
 GetResponse.autoload :Connection, "get_response/connection"
 GetResponse.autoload :Contact, "get_response/contact"
-GetResponse.autoload :Message, "get_response/message"
+GetResponse.autoload :Message, "get_response/message"
+GetResponse.autoload :CampaignProxy, "get_response/campaign_proxy"
+GetResponse.autoload :ContactProxy, "get_response/contact_proxy"

data/lib/get_response/account.rb

@@ -1,6 +1,6 @@
 module GetResponse
 
-  # GetResponse Account
+  # GetResponse Account.
   class Account
     attr_reader :login, :name, :email, :created_on
 

data/lib/get_response/campaign.rb

@@ -5,14 +5,25 @@ module GetResponse
     attr_reader :id, :name, :from_name, :from_email, :reply_to_email, :created_on
 
 
-    def initialize(params)
+    def initialize(params, connection)
       @id = params["id"]
       @name = params["name"]
       @from_name = params["from_name"]
       @from_email = params["from_email"]
       @reply_to_email = params["reply_to_email"]
       @created_on = params["created_on"]
+      @connection = connection
     end
+
+
+    # Get all contacts assigned to this campaign.
+    #
+    # returns:: [GetResponse::Contact]
+    def contacts
+      @contact_proxy = ContactProxy.new(@connection)
+      @contact_proxy.all(:campaigns => [@id])
+    end
+
   end
 
 end

data/lib/get_response/campaign_proxy.rb

@@ -0,0 +1,23 @@
+module GetResponse
+
+  # Proxy class for campaign operations.
+  class CampaignProxy
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+
+    # Get all campaigns from account.
+    #
+    # returns:: Array of GetResponse::Campaign
+    def all
+      response = @connection.send_request("get_campaigns", {})["result"]
+      response.inject([]) do |campaigns, resp|
+        campaigns << Campaign.new(resp[1].merge("id" => resp[0]), @connection)
+      end
+    end
+
+  end
+
+end

data/lib/get_response/connection.rb

@@ -8,20 +8,11 @@ module GetResponse
 
     attr_reader :api_key
 
-
-    private_class_method :new
-
-
     def initialize(api_key)
       @api_key = api_key
     end
 
 
-    def self.instance(api_key = "")
-      @@instance ||= new(api_key)
-    end
-
-
     # Test connection with API.
     #
     # returns:: Boolean
@@ -31,78 +22,28 @@ module GetResponse
     end
 
 
-    # Get basic info about your account
+    # Get basic info about your account.
     #
     # returns:: GetResponse::Account
-    def get_account_info
+    def account
       resp = self.send_request("get_account_info")
       GetResponse::Account.new(resp["result"])
     end
 
 
-    # Get list of active campaigns in account. There are allowed operators for building conditions.
-    # More info about operators http://dev.getresponse.com/api-doc/#operators
-    #
-    #   gr_connection.get_campaings
-    #
-    # Get list of all active campaigns with name "my_campaign" and from_email is from domain "mybiz.xx"
-    #
-    #   gr_connection.get_campaings(:name.is_eq => "my_campaign", :from_email.contain => "%mybiz.xx")
-    #
-    # get_campaings(:name.eq => "my name")
-    def get_campaigns(conditions = {})
-      req_cond = build_conditions(conditions)
-
-      response = send_request("get_campaigns", req_cond)["result"]
-      response.inject([]) do |campaings, resp|
-        campaings << Campaign.new(resp[1].merge("id" => resp[0]))
-      end
-    end
-
-
-    # Get single campaign using <tt>campaign_id</tt>.
-    #
-    # campaign_id:: Integer || String
-    #
-    # returns:: GetResponse::Campaign || nil
-    def get_campaign(campaign_id)
-      result = self.get_campaigns(:id.is_eq => campaign_id)
-      result.first
-    end
-
-
-    # TODO: untested!
-    # Get messages in account.
-    # Conditions:
-    #   * campaigns / get_campaigns (optional) – Search only in given campaigns. Uses OR logic.
-    #     If those params are not given search, is performed in all campaigns in the account.
-    #     Check IDs in conditions for detailed explanation.
-    #   * type (optional) – Use newsletter or follow-up to narrow down search results to specific
-    #     message types.
-    #   * subject (optional) – Use text operators to narrow down search results to specific message subjects.
-    #
-    # conditions::  Hash
+    # Method returns proxy to execute all campaign related operations.
     #
-    # returns:: [Message]
-    def get_messages(conditions = {})
-      req_cond = build_conditions(conditions)
-
-      response = send_request("get_messages", req_cond)["result"]
-      response.inject([]) do |messages, resp|
-        messages << Message.new(resp[1].merge("id" => resp[0]))
-      end
+    # returns:: GetResponse::CampaignProxy
+    def campaigns
+      @campaign_proxy ||= GetResponse::CampaignProxy.new(self)
     end
 
 
-    # Get single message using <tt>message_id</tt>.
-    #
-    # message_id::  Integer || String
+    # Method returns proxy to execute all contact related operations.
     #
-    # returns:: Message
-    def get_message(message_id)
-      response = self.send_request("get_message", { "message" => message_id })["result"]
-      return nil if response.empty?
-      Message.new(response[message_id].merge("id" => message_id))
+    # returns:: GetResponse::ContactProxy
+    def contacts
+      @contact_proxy ||= GetResponse::ContactProxy.new(self)
     end
 
 
@@ -121,6 +62,7 @@ module GetResponse
       resp = Net::HTTP.start(uri.host, uri.port) do |conn|
         conn.post("/", request_params)
       end
+      raise GetResponseError.new("API key verification failed") if resp.code.to_i == 403
       response = JSON.parse(resp.body)
       if response["error"]
         raise GetResponse::GetResponseError.new(response["error"])

data/lib/get_response/contact.rb

@@ -6,7 +6,7 @@ module GetResponse
     attr_reader :id
 
 
-    def initialize(params)
+    def initialize(params, connection)
       @campaign = params["campaign"]
       @name = params["name"]
       @email = params["email"]
@@ -14,31 +14,7 @@ module GetResponse
       @ip = params["ip"]
       @customs = parse_customs(params["customs"])
       @id = params["id"]
-    end
-
-
-    # Add contact to the list. Method raises an exception <tt>GetResponseError</tt> if contact can't
-    # be added (bad email syntax for example).
-    # Example:
-    #   GetResponse::Contact.create("email" => "john@doe.org", "name => "John D.", "campaign" => "N67")
-    #
-    # params:: Hash - attributes for new contact
-    # returns:: Boolean - true if contact queued for create
-    def self.create(params)
-      contact = Contact.new(params)
-      contact.save
-    end
-
-
-    # Find all contacts associated with GetResponse account
-    #
-    # returns:: [Contact]
-    def self.find_all
-      response = GetResponse::Connection.instance.send_request("get_contacts", {})
-
-      response["result"].inject([]) do |contacts, resp|
-        contacts << Contact.new(resp[1].merge("id" => resp[0]))
-      end
+      @connection = connection
     end
 
 
@@ -47,9 +23,7 @@ module GetResponse
     #
     # returns:: Boolean
     def save
-      connection = GetResponse::Connection.instance
-
-      result = connection.send_request(:add_contact, self.attributes)
+      result = @connection.send_request(:add_contact, self.attributes)
       result["error"].nil?
     end
 
@@ -80,7 +54,7 @@ module GetResponse
     def destroy
       raise GetResponse::GetResponseError.new("Can't delete contact without id") unless @id
 
-      resp = GetResponse::Connection.instance.send_request("delete_contact", { "contact" => @id })
+      resp = @connection.send_request("delete_contact", { "contact" => @id })
       resp["result"]["deleted"].to_i == 1
     end
 
@@ -104,7 +78,7 @@ module GetResponse
     # returns:: Boolean
     def move(new_campaign_id)
       param = { "contact" => @id, "campaign" => new_campaign_id }
-      result = GetResponse::Connection.instance.send_request("move_contact", param)
+      result = @connection.send_request("move_contact", param)
       result["result"]["updated"].to_i == 1
     end
 
@@ -114,7 +88,7 @@ module GetResponse
     # returns:: Hash
     def geoip
       param = { "contact" => @id }
-      GetResponse::Connection.instance.send_request("get_contact_geoip", param)["result"]
+      @connection.send_request("get_contact_geoip", param)["result"]
     end
 
 
@@ -125,7 +99,7 @@ module GetResponse
     # returns:: true
     def set_cycle(value)
       param = { "contact" => @id, "cycle_day" => value }
-      GetResponse::Connection.instance.send_request("set_contact_cycle", param)["result"]["updated"].to_i == 1
+      @connection.send_request("set_contact_cycle", param)["result"]["updated"].to_i == 1
     end
 
 

data/lib/get_response/contact_proxy.rb

@@ -0,0 +1,38 @@
+module GetResponse
+
+  # Proxy class for contact related operations.
+  class ContactProxy
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+
+    # Get all contacts from account. Conditions could be passed to method. Returned contacts
+    # will be limited to passed conditions eg. to certain campaign. For more examples of conditions
+    # visit: http://dev.getresponse.com/api-doc/#get_contacts
+    # Example:
+    #   @contact_proxy.all(:campaigns => ["my_campaign_id"])
+    #
+    # returns:: Array of GetResponse::Contact
+    def all(conditions = {})
+      response = @connection.send_request("get_contacts", conditions)
+
+      response["result"].inject([]) do |contacts, resp|
+        contacts << Contact.new(resp[1].merge("id" => resp[0]), @connection)
+      end
+    end
+
+
+    # Create new contact. Method can raise <tt>GetResponseError</tt>.
+    #
+    # returns:: GetResponse::Contact
+    def create(attrs)
+      contact = GetResponse::Contact.new(attrs, @connection)
+      contact.save
+      contact
+    end
+
+  end
+
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: getresponse
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Sebastian Nowak
@@ -14,16 +14,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 +01:00
+date: 2010-12-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 4
@@ -34,9 +36,11 @@ dependencies:
   name: json_pure
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 4
@@ -47,9 +51,11 @@ dependencies:
   name: rr
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
@@ -65,13 +71,15 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/get_response.rb
 - lib/get_response/account.rb
-- lib/get_response/contact.rb
 - lib/get_response/campaign.rb
-- lib/get_response/message.rb
+- lib/get_response/campaign_proxy.rb
 - lib/get_response/connection.rb
+- lib/get_response/contact.rb
+- lib/get_response/contact_proxy.rb
 - lib/get_response/get_response_error.rb
+- lib/get_response/message.rb
+- lib/get_response.rb
 - README.rdoc
 has_rdoc: true
 homepage: http://dev.getresponse.com
@@ -83,16 +91,20 @@ 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"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 17
       segments: 
       - 1
       - 3
@@ -101,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for GetResponse API