getresponse 0.5.1 → 0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3309e86caff2f7bca56e22496abc0c7148354a82
+  data.tar.gz: 04288f448042fbee0e3d6445ef5e0a710096b83e
+SHA512:
+  metadata.gz: 180a21cb1e8df1cd3ac10649c969ce0d0b9cb5c556ff8979c8350f51d5c304966432d797493f3765bb4e08c41c80ac53d3206045bd3cb215cfef0b9a876f9017
+  data.tar.gz: 8e46c79c8fb8a641cffb498b59a112aeb45356511214ee0a7bd96020e798e5b4706491a7f53b4df20d34c8b8de2ce4a0367f7835a7ece008b0455d879f31f572

data/README.rdoc

@@ -4,12 +4,21 @@ Wrapper for GetResponse API.
 Class interfaces from version 0.2 has changed breaking backward compatibility.
 Be sure to check changes before update.
 
+== Compatibility issue
+
+Next release (0.6) of getresponse gem will not be compatible with Ruby 1.8.
+
 == Usage
 
 Just add to you Gemfile
 
   gem "getresponse", :require => "get_response"
 
+GetResponse offers three API end point according which type of client you are. Standard retail
+clients (getresponse.com etc.) should use GetResponse::Connection class to communicate with API. If
+you are client of getresponse360.com class GetResponse::DedicatedUsConnection will suit for you.
+Client of polish getresponse360.pl should use GetResponse::DedicatedPlConnection.
+
 Test connection to GetResponse API.
 
   gr_connection = GetResponse::Connection.new("my_secret_api")
@@ -59,7 +68,6 @@ Move contact between campaigns:
   # zXy - existing campaign
   contact.move("zXy")
 
-
 Get geoip location
 
   # with connection
@@ -205,3 +213,14 @@ Fetching blacklisted addresses for account
 Fetching blacklisted addresses for campaign
 
   campaign.blacklist
+
+Creating follow up message:
+
+  campaign.create_follow_up({
+    "subject" => "My new followup",
+    "day_of_cycle" => 1024,
+    "contents" => {
+      "plain" => "Hello, it is my follow up!",
+      "html" => "<b>Hello</b>, it is my follow up!"
+    }
+  })

data/lib/get_response.rb

@@ -26,4 +26,6 @@ GetResponse.autoload :ConfirmationSubjectProxy, "get_response/confirmation_subje
 GetResponse.autoload :Conditions, "get_response/conditions"
 GetResponse.autoload :LinksProxy, "get_response/links_proxy"
 GetResponse.autoload :Link, "get_response/link"
-GetResponse.autoload :Blacklist, "get_response/blacklist"
+GetResponse.autoload :Blacklist, "get_response/blacklist"
+GetResponse.autoload :DedicatedUsConnection, "get_response/dedicated_us_connection"
+GetResponse.autoload :DedicatedPlConnection, "get_response/dedicated_pl_connection"

data/lib/get_response/campaign.rb

@@ -20,7 +20,7 @@ module GetResponse
 
     # Get all contacts assigned to this campaign.
     #
-    # returns:: [GetResponse::Contact]
+    # @return [GetResponse::Contact]
     def contacts
       @contact_proxy = ContactProxy.new(@connection)
       @contact_proxy.all(:campaigns => [@id])
@@ -38,7 +38,7 @@ module GetResponse
 
     # Get domain assigned to this campaign.
     #
-    # returns:: GetResponse::Domain
+    # @return [GetResponse::Domain]
     def domain
       params = {"campaign" => self.id}
       domain = @connection.send_request("get_campaign_domain", params)["result"].map do |id, attrs|
@@ -50,8 +50,8 @@ module GetResponse
 
     # Set domain for this campaign.
     #
-    # new_domain:: GetResponse::Domain
-    # returns:: GetResponse::Domain
+    # @param [GetResponse::Domain] new_domain
+    # @return [GetResponse::Domain]
     def domain=(new_domain)
       params = { "domain" => new_domain.id, "campaign" => self.id }
 
@@ -198,6 +198,29 @@ module GetResponse
       GetResponse::Blacklist.new(entries, @connection, self)
     end
 
+
+    # Create follow up message in campaign.
+    #
+    # Example:
+    #
+    #   @campaing.create_follow_up({
+    #     "subject" => "My new followup",
+    #     "day_of_cycle" => 1024,
+    #     "contents" => {
+    #       "plain" => "Hello, it is my follow up!",
+    #       "html" => "<b>Hello</b>, it is my follow up!"
+    #     }
+    #   })
+    #
+    # @param follow_up_attributes [Hash]
+    # @return [GetResponse::FollowUp]
+    def create_follow_up(follow_up_attributes)
+      follow_up_attributes.merge!("campaign_id" => @id)
+      GetResponse::FollowUp.new(follow_up_attributes, @connection).tap do |follow_up|
+        follow_up.save
+      end
+    end
+
   end
 
 end

data/lib/get_response/connection.rb

@@ -4,7 +4,7 @@ module GetResponse
 
   # Simple class that simulates connection to service
   class Connection
-    API_URI = "http://api2.getresponse.com"
+    API_URI = "http://api2.getresponse.com/"
 
     attr_reader :api_key
 
@@ -85,9 +85,10 @@ module GetResponse
         :params => [@api_key, params]
       }.to_json
 
-      uri = URI.parse(API_URI)
+      uri = URI.parse(self.class::API_URI)
       resp = Net::HTTP.start(uri.host, uri.port) do |conn|
-        conn.post("/", request_params)
+        puts uri.inspect
+        conn.post(uri.path, request_params)
       end
       raise GetResponseError.new("API key verification failed") if resp.code.to_i == 403
       raise GetResponseError.new("204 No content response received which signifies interpreting request as notification") if resp.code.to_i == 204

data/lib/get_response/dedicated_pl_connection.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module GetResponse
+
+  # Class simulates connection to API of getresponse360.pl service.
+  class DedicatedPlConnection < Connection
+
+    API_URI = "http://api.getresponse360.pl/CRYPTO"
+
+  end
+
+end
+

data/lib/get_response/dedicated_us_connection.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module GetResponse
+
+  # Class simulates connection to API of getresponse360.com service.
+  class DedicatedUsConnection < Connection
+
+    API_URI = "http://api.getresponse360.com/CRYPTO"
+
+  end
+
+end
+

data/lib/get_response/follow_up.rb

@@ -21,6 +21,20 @@ module GetResponse
       @day_of_cycle = value.to_i if response["updated"].to_i == 1
     end
 
+
+    # Save follow-up message. When object can't be saved <tt>GetResponseError</tt> is raised,
+    # otherwise returns <tt>true</tt>.
+    def save
+      params = {
+        campaign: @campaign_id,
+        subject: @subject,
+        contents: @contents,
+        day_of_cycle: @day_of_cycle
+      }
+      result = @connection.send_request(:add_follow_up, params)
+      result["added"] == 1
+    end
+
   end
 
 end

data/lib/get_response/message.rb

@@ -12,6 +12,8 @@ module GetResponse
       @flags = params["flags"] || []
       @created_on = params["created_on"]
       @connection = connection
+      @campaign_id = params["campaign_id"]
+      @contents = params["contents"]
     end
 
 

metadata

@@ -1,118 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: getresponse
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.5.1
+  version: '0.6'
 platform: ruby
 authors:
 - Sebastian Nowak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
+  name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-  name: json
 - !ruby/object:Gem::Dependency
-  type: :runtime
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-  name: json_pure
 - !ruby/object:Gem::Dependency
-  type: :development
+  name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-  name: rr
-description: With this gem you can manage your subscribers, campaigns, messages
+description: With this gem you can manage your subscribers, campaigns, messages etc.
 email: sebastian.nowak@implix.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/get_response.rb
-- lib/get_response/from_field.rb
-- lib/get_response/confirmation_subject.rb
-- lib/get_response/domain_proxy.rb
-- lib/get_response/confirmation_subject_proxy.rb
-- lib/get_response/contact_proxy.rb
-- lib/get_response/confirmation_body_proxy.rb
-- lib/get_response/message_proxy.rb
-- lib/get_response/confirmation_body.rb
-- lib/get_response/newsletter.rb
 - lib/get_response/account.rb
-- lib/get_response/link.rb
-- lib/get_response/contact.rb
-- lib/get_response/campaign_proxy.rb
+- lib/get_response/blacklist.rb
 - lib/get_response/campaign.rb
-- lib/get_response/message.rb
+- lib/get_response/campaign_proxy.rb
+- lib/get_response/conditions.rb
+- lib/get_response/confirmation_body.rb
+- lib/get_response/confirmation_body_proxy.rb
+- lib/get_response/confirmation_subject.rb
+- lib/get_response/confirmation_subject_proxy.rb
 - lib/get_response/connection.rb
+- lib/get_response/contact.rb
+- lib/get_response/contact_proxy.rb
+- lib/get_response/dedicated_pl_connection.rb
+- lib/get_response/dedicated_us_connection.rb
+- lib/get_response/domain.rb
+- lib/get_response/domain_proxy.rb
 - lib/get_response/follow_up.rb
-- lib/get_response/conditions.rb
+- lib/get_response/from_field.rb
 - lib/get_response/from_fields_proxy.rb
-- lib/get_response/domain.rb
-- lib/get_response/blacklist.rb
-- lib/get_response/links_proxy.rb
 - lib/get_response/get_response_error.rb
-- lib/api.rb
+- lib/get_response/link.rb
+- lib/get_response/links_proxy.rb
+- lib/get_response/message.rb
+- lib/get_response/message_proxy.rb
+- lib/get_response/newsletter.rb
+- lib/get_response.rb
 - README.rdoc
 homepage: http://dev.getresponse.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrapper for GetResponse API
 test_files: []

data/lib/api.rb

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