getresponse 0.2 → 0.3

data/README.rdoc

@@ -66,4 +66,42 @@ Set contact cycle
 
   # with connection
   # contact - existing contact
-  contact.set_cycle(5)
+  contact.set_cycle(5)
+
+Get custom attributes
+
+  # with connection
+  # contact - existing contact
+  contact.customs
+  => { "attr_name" => "attr_value" }
+
+Get account from fields
+
+  # with account
+  # account - existing account
+  account.from_fields.all
+  => [<FromField: xcv>]
+
+Add account from field
+
+  # with account
+  # account = existing account
+  account.from_fields.create("name" => "My new name", "email" => "my_new_email@foo.bar")
+  => #<GetResponse::FromField:0xb7727010 ... >
+
+Get account domains
+
+  # with account
+  # account - existing account
+  account.domains.all
+
+Get campaign domain
+
+  # with campaign
+  # campaign - existing campaign
+  campaign.domain
+
+Set campaign domain
+
+  domain = account.domains.first
+  campaign.domain = domain

data/lib/api.rb

@@ -0,0 +1 @@
+API_KEY='d333e12e5019b6940127e82b499d75a5'

data/lib/api_key.rb

@@ -0,0 +1 @@
+API_KEY='d333e12e5019b6940127e82b499d75a5'

data/lib/get_response.rb

@@ -49,4 +49,8 @@ GetResponse.autoload :Connection, "get_response/connection"
 GetResponse.autoload :Contact, "get_response/contact"
 GetResponse.autoload :Message, "get_response/message"
 GetResponse.autoload :CampaignProxy, "get_response/campaign_proxy"
-GetResponse.autoload :ContactProxy, "get_response/contact_proxy"
+GetResponse.autoload :ContactProxy, "get_response/contact_proxy"
+GetResponse.autoload :FromField, "get_response/from_field"
+GetResponse.autoload :FromFieldsProxy, "get_response/from_fields_proxy"
+GetResponse.autoload :Domain, "get_response/domain"
+GetResponse.autoload :DomainProxy, "get_response/domain_proxy"

data/lib/get_response/account.rb

@@ -5,11 +5,23 @@ module GetResponse
     attr_reader :login, :name, :email, :created_on
 
 
-    def initialize(params)
+    def initialize(params, connection)
       @login = params["login"]
       @name = params["from_name"]
       @email = params["from_email"]
       @created_on = params["created_on"]
+      @connection = connection
     end
+
+
+    def from_fields
+      FromFieldsProxy.new(@connection)
+    end
+
+
+    def domains
+      DomainProxy.new(@connection)
+    end
+
   end
 end

data/lib/get_response/campaign.rb

@@ -24,6 +24,31 @@ module GetResponse
       @contact_proxy.all(:campaigns => [@id])
     end
 
+
+    # Get domain assigned to this campaign.
+    #
+    # returns:: GetResponse::Domain
+    def domain
+      params = {"campaign" => self.id}
+      domain = @connection.send_request("get_campaign_domain", params)["result"].map do |id, attrs|
+        Domain.new(attrs.merge("id" => id))
+      end
+      domain.first
+    end
+
+
+    # Set domain for this campaign.
+    #
+    # new_domain:: GetResponse::Domain
+    # returns:: GetResponse::Domain
+    def domain=(new_domain)
+      params = { "domain" => new_domain.id, "campaign" => self.id }
+
+      # there will be an exception if bad ids sent
+      @connection.send_request("set_campaign_domain", params)
+      new_domain
+    end
+
   end
 
 end

data/lib/get_response/connection.rb

@@ -27,7 +27,7 @@ module GetResponse
     # returns:: GetResponse::Account
     def account
       resp = self.send_request("get_account_info")
-      GetResponse::Account.new(resp["result"])
+      GetResponse::Account.new(resp["result"], self)
     end
 
 

data/lib/get_response/contact.rb

@@ -103,6 +103,24 @@ module GetResponse
     end
 
 
+    # Get list of custom attributes. It performs additional API request to fetch attributes. By
+    # default new contacts has en empty custom attributes list.
+    #
+    # returns:: Hash
+    def customs
+      @connection.send_request("get_contact_customs", { "contact" => @id })["result"]
+    end
+
+
+    # Set custom attributes in contact instance. After set attributes you _must_ save contact.
+    #
+    # value:: Hash
+    # returns:: Hash
+    def customs=(value)
+      @customs = parse_customs(value)
+    end
+
+
     protected
 
 

data/lib/get_response/domain.rb

@@ -0,0 +1,16 @@
+module GetResponse
+
+  # Domain connected with account or campaign in GetResponse
+  class Domain
+
+    attr_reader :id, :domain, :created_on
+
+    def initialize(attributes)
+      @id         = attributes["id"]
+      @domain     = attributes["domain"]
+      @created_on = attributes["created_on"]
+    end
+
+  end
+
+end

data/lib/get_response/domain_proxy.rb

@@ -0,0 +1,23 @@
+module GetResponse
+
+  # Proxy class for domain operations.
+  class DomainProxy
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+
+    # Get all domains connected with account.
+    #
+    # returns:: [GetResponse::Domain]
+    def all
+      domains_attrs = @connection.send_request("get_account_domains")["result"]
+      domains_attrs.map do |id, attrs|
+        GetResponse::Domain.new(attrs.merge("id" => id))
+      end
+    end
+
+  end
+
+end

data/lib/get_response/from_field.rb

@@ -0,0 +1,18 @@
+module GetResponse
+
+  # Form field connected with account.
+  class FromField
+
+    attr_reader :id, :name, :email, :created_on
+
+
+    def initialize(params)
+      @id         = params["id"]
+      @name       = params["name"]
+      @email      = params["email"]
+      @created_on = params["created_on"]
+    end
+
+  end
+
+end

data/lib/get_response/from_fields_proxy.rb

@@ -0,0 +1,33 @@
+module GetResponse
+
+  # Proxy class from all from fields operations.
+  class FromFieldsProxy
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+
+    # Fetch all from fields connected with account
+    #
+    # returns:: [FromFields]
+    def all
+      from_fields_attrs = @connection.send_request("get_account_from_fields")["result"]
+      from_fields_attrs.map do |id, attrs|
+        FromField.new(attrs.merge("id" => id))
+      end
+    end
+
+
+    # Create new from field connection with account. Method returns new instance of <tt>FromField</tt>
+    # if new from field was saved or raise <tt>GetResponseError</tt> if not.
+    #
+    # returns:: FromField
+    def create(attributes)
+      add_result = @connection.send_request("add_account_from_field", attributes)["result"]
+      FromField.new(attributes.merge("id" => add_result["FROM_FIELD_ID"]))
+    end
+
+  end
+
+end

metadata

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