getresponse 0.3.1 → 0.4

data/README.rdoc

@@ -104,4 +104,35 @@ Get campaign domain
 Set campaign domain
 
   domain = account.domains.first
-  campaign.domain = domain
+  campaign.domain = domain
+
+Get campaign messages
+
+  # with campaign
+  # campaign - existing campaign
+  messages = campaign.messages
+  newsletters = campaign.messages(:type => "newsletter")
+
+Get message contents
+
+  # with message
+  # message - existing messsage
+  message.contents["plain"]
+  message.contents["html"]
+
+Get stats of message
+
+  # message - existing message
+  message.stats
+
+Delete message
+
+  # message - existing message
+  message.destroy
+
+Get/set campaign's postal address
+
+  # campaign_one - existing campaign
+  # campaign_two - existing campaign
+  postal_address = campaign_one.postal_address
+  campaign_two.postal_address = postal_address

data/lib/api.rb

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

data/lib/get_response.rb

@@ -53,4 +53,7 @@ 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"
+GetResponse.autoload :DomainProxy, "get_response/domain_proxy"
+GetResponse.autoload :MessageProxy, "get_response/message_proxy"
+GetResponse.autoload :Newsletter, "get_response/newsletter"
+GetResponse.autoload :FollowUp, "get_response/follow_up"

data/lib/get_response/campaign.rb

@@ -49,6 +49,41 @@ module GetResponse
       new_domain
     end
 
+
+    # Get messages assigned to this campaign. Optionally conditions <tt>Hash</tt> can be passed, for
+    # example to get campaign messages which are newsletters only.
+    # Example:
+    #   @campaign.messages
+    #   @campaign.messages(:type => "newsletter")
+    #
+    # returns:: [GetResponse::Message]
+    def messages(conditions = {})
+      conditions[:campaigns]= [@id]
+      @message_proxy = MessageProxy.new @connection
+      @message_proxy.all(conditions)
+    end
+
+
+    # Get campaign's postal address and and postal design (formatting). Postal address is returned
+    # as <tt>Hash</tt> instance.
+    #
+    # returns:: Hash
+    def postal_address
+      @connection.send_request("get_campaign_postal_address", "campaign" => @id)["result"]
+    end
+
+
+    # Set postal address and postal design (formatting) in campaign. If something goes wrong
+    # exception <tt>GetResponse::GetResponseError</tt>.
+    #
+    # postal_address_hash:: Hash
+    # returns:: Hash
+    def postal_address=(postal_address_hash)
+      params = {"campaign" => @id}.merge(postal_address_hash)
+      result = @connection.send_request("set_campaign_postal_address", params)["result"]
+      result if result["updated"].to_i == 1
+    end
+
   end
 
 end

data/lib/get_response/follow_up.rb

@@ -0,0 +1,27 @@
+module GetResponse
+
+  class FollowUp < Message
+
+    attr_reader :day_of_cycle
+
+    # Delete follow up message.
+    def destroy
+      response = @connection.send_request("delete_follow_up", :message => @id)["result"]
+      response["deleted"].to_i == 1
+    end
+
+
+    # Method sets a day of cycle for follow-up. Passed value must be integer number. There can't be
+    # more than one follow-up for day.
+    #
+    # value:: Fixnum
+    def day_of_cycle=(value)
+      params = {:message => @id, :day_of_cycle => value}
+      response = @connection.send_request("set_follow_up_cycle", params)["result"]
+      @day_of_cycle = value.to_i if response["updated"].to_i == 1
+    end
+
+  end
+
+end
+

data/lib/get_response/message.rb

@@ -2,15 +2,36 @@ module GetResponse
 
   # Class representa a message in GetResponse
   class Message
-    attr_reader :id, :type, :subject, :day_of_cycle, :flags, :created_on
+    attr_reader :id, :type, :subject, :flags, :created_on
 
-    def initialize(params)
+    def initialize(params, connection)
       @id = params["id"]
       @type = params["type"]
       @subject = params["subject"]
       @day_of_cycle = params["day_of_cycle"]
       @flags = params["flags"] || []
       @created_on = params["created_on"]
+      @connection = connection
+    end
+
+
+    # Content of message. Every message has two kinds of content: plain and html. Method returns
+    # <tt>Hash</tt> instance with keys <tt>"plain"</tt> and <tt>"html"</tt>.
+    #
+    # returns:: Hash
+    def contents
+      resp = @connection.send_request("get_message_contents", :message => @id)
+      resp["result"]
+    end
+
+
+    # Stats of message. Method returns <tt>Hash</tt> instance where hey is a date and value is
+    # set of data.
+    #
+    # returns:: Hash
+    def stats
+      resp = @connection.send_request("get_message_stats", :message => @id)
+      resp["result"]
     end
   end
 end

data/lib/get_response/message_proxy.rb

@@ -0,0 +1,45 @@
+module GetResponse
+
+  # Proxy class for message related operations.
+  class MessageProxy
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+
+    # Get all messages from account. <tt>Hash</tt> with conditions can be optionally passed as
+    # parameter.
+    # Example:
+    #   @message_proxy.all
+    #   => [<GetResponse::Message ...>, <GetResponse::Message ...>]
+    #   @message_proxy.all(:campaigns => ["my_campaign_id"]
+    #   => [<GetResponse::Message ...>, <GetResponse::Message ...>]
+    #
+    # conditions::  Hash, empty by default
+    # returns:: Array of GetResponse::Message
+    def all(conditions = {})
+      response = @connection.send_request("get_messages", conditions)
+
+      response["result"].inject([]) do |messages, resp|
+        messages << message_ancestor_object(resp)
+        # messages << Message.new(resp[1].merge("id" => resp[0]), @connection)
+      end
+    end
+
+
+    protected
+
+
+    def message_ancestor_object(response)
+      case response[1]["type"]
+        when "newsletter"
+          Newsletter.new(response[1].merge("id" => response[0]), @connection)
+        when "follow-up"
+          FollowUp.new(response[1].merge("id" => response[0]), @connection)
+      end
+    end
+
+  end
+
+end

data/lib/get_response/newsletter.rb

@@ -0,0 +1,15 @@
+module GetResponse
+
+  class Newsletter < Message
+
+    # Delete newsletter. You can delete only newsletters that have send_on date in future. If you try
+    # to delete exception will be raised.
+    def destroy
+      resp = @connection.send_request("delete_newsletter", :message => @id)["result"]
+      resp["deleted"].to_i == 1
+    end
+
+  end
+
+end
+

metadata

@@ -4,9 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  version: "0.4"
 platform: ruby
 authors: 
 - Sebastian Nowak
@@ -14,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-06 00:00:00 +01:00
+date: 2011-06-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,15 +68,19 @@ files:
 - lib/get_response/from_field.rb
 - lib/get_response/domain_proxy.rb
 - lib/get_response/contact_proxy.rb
+- lib/get_response/message_proxy.rb
+- lib/get_response/newsletter.rb
 - lib/get_response/account.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/follow_up.rb
 - lib/get_response/from_fields_proxy.rb
 - lib/get_response/domain.rb
 - lib/get_response/get_response_error.rb
+- lib/api.rb
 - README.rdoc
 has_rdoc: true
 homepage: http://dev.getresponse.com