getresponse 0.5 → 0.5.1

data/README.rdoc

@@ -6,6 +6,10 @@ Be sure to check changes before update.
 
 == Usage
 
+Just add to you Gemfile
+
+  gem "getresponse", :require => "get_response"
+
 Test connection to GetResponse API.
 
   gr_connection = GetResponse::Connection.new("my_secret_api")
@@ -187,4 +191,17 @@ Get single confirmation subject by id
 
 Create new campaign
 
-  connection.campaigns.create(new_campaign_attributes)
+  connection.campaigns.create(new_campaign_attributes)
+
+Fetching links embedded in messages
+
+  connection.links.all
+  message.links
+
+Fetching blacklisted addresses for account
+
+  account.blacklist
+
+Fetching blacklisted addresses for campaign
+
+  campaign.blacklist

data/lib/api.rb

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

data/lib/get_response.rb

@@ -2,45 +2,6 @@ require "rubygems"
 require 'json'
 
 module GetResponse
-
-  # Operators that may be used in queries to GetResponse API service
-  OPERATORS = {
-    "is_eq"       => "EQUALS",
-    "is_not_eq"   => "NOT_EQUALS",
-    "contain"     => "CONTAINS",
-    "not_contain" => "NOT_CONTAINS",
-    "match"       => "MATCHES"
-  }
-
-end
-
-
-class SymbolOperator
-  attr_reader :field, :operator
-
-  def initialize(field, operator)
-    @field, @operator = field, operator
-  end unless method_defined?(:initialize)
-
-
-  def evaluate(value)
-    warn "[DEPRECATION] evaluation of GetResponse operators is deprecated."
-    { field.to_s => { gr_operator => value } }
-  end
-
-
-  def gr_operator
-    GetResponse::OPERATORS[@operator]
-  end
-end
-
-
-class Symbol
-  GetResponse::OPERATORS.keys.each do |operator|
-    define_method(operator) do
-      SymbolOperator.new(self, operator)
-    end unless method_defined?(operator)
-  end
 end
 
 GetResponse.autoload :GetResponseError, "get_response/get_response_error"
@@ -62,4 +23,7 @@ GetResponse.autoload :ConfirmationBody, "get_response/confirmation_body"
 GetResponse.autoload :ConfirmationBodyProxy, "get_response/confirmation_body_proxy"
 GetResponse.autoload :ConfirmationSubject, "get_response/confirmation_subject"
 GetResponse.autoload :ConfirmationSubjectProxy, "get_response/confirmation_subject_proxy"
-GetResponse.autoload :Conditions, "get_response/conditions"
+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"

data/lib/get_response/account.rb

@@ -23,5 +23,14 @@ module GetResponse
       DomainProxy.new(@connection)
     end
 
+
+    # Get the entire blacklisted emails list for this account.
+    #
+    # @return [Blacklist]
+    def blacklist
+      entries = @connection.send_request("get_account_blacklist")["result"].values
+      GetResponse::Blacklist.new(entries, @connection, self)
+    end
+
   end
 end

data/lib/get_response/blacklist.rb

@@ -0,0 +1,30 @@
+require 'forwardable'
+
+module GetResponse
+
+  # Class represents list of blacklisted email addresses.
+  class Blacklist
+    extend ::Forwardable
+
+    def_delegator :@entries, :size
+    def_delegator :@entries, :empty?
+
+    # To instantiate new blacklist object use this method. Blacklist may contain addresses connected
+    # with GetResponse account or with one particular campaign.
+    #
+    # Example:
+    #
+    #   Blacklist.new(['foo@bar', 'bar@foo'], @connection, @account)
+    #
+    # @param entries [Array] collection of blacklisted addresses
+    # @param connection [GetResponse::Connection] connection of which all operations will be performed
+    # @param ancestor [GetResponse::Account, GetResponse::Campaign] object owner of blacklist
+    def initialize(entries, connection, ancestor)
+      @entries = entries
+      @connection = connection
+      @ancestor = ancestor
+    end
+  end
+
+end
+

data/lib/get_response/campaign.rb

@@ -188,6 +188,16 @@ module GetResponse
       self
     end
 
+
+    # Get the entire blacklisted emails list for this campaign.
+    #
+    # @return [GetResponse::Blacklist]
+    def blacklist
+      params = {"campaign" => @id}
+      entries = @connection.send_request("get_campaign_blacklist", params)["result"].values
+      GetResponse::Blacklist.new(entries, @connection, self)
+    end
+
   end
 
 end

data/lib/get_response/confirmation_subject_proxy.rb

@@ -37,7 +37,7 @@ module GetResponse
       params = {"confirmation_subject" => subject_id}
       resp = @connection.send_request("get_confirmation_subject", params)["result"]
       raise GetResponseError.new "Confirmation subject with id '#{subject_id}' not found." if resp.empty?
-      subject_attrs = resp.values[0].merge("id" => resp.keys.first)
+      subject_attrs = resp[subject_id.to_s].merge("id" => subject_id.to_s)
       ConfirmationSubject.new subject_attrs
     end
 

data/lib/get_response/connection.rb

@@ -10,6 +10,8 @@ module GetResponse
 
     def initialize(api_key)
       @api_key = api_key
+      @request_id_prefix = "#{Time.now.to_i}-#{rand(1_000_000_000)}"
+      @request_number = -1
     end
 
 
@@ -78,6 +80,7 @@ module GetResponse
     # params::  Hash
     def send_request(method, params = {})
       request_params = {
+        :id => request_id,
         :method => method,
         :params => [@api_key, params]
       }.to_json
@@ -87,6 +90,7 @@ module GetResponse
         conn.post("/", 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
       response = JSON.parse(resp.body)
       if response["error"]
         raise GetResponse::GetResponseError.new(response["error"])
@@ -95,6 +99,14 @@ module GetResponse
     end
 
 
+    # Method return proxy to execute all links related operations.
+    #
+    # @return [LinksProxy]
+    def links
+      @links_proxy ||= LinksProxy.new(self)
+    end
+
+
     protected
 
 
@@ -113,6 +125,11 @@ module GetResponse
       end
     end
 
+    def request_id
+      @request_number += 1
+      return [@request_id_prefix, @request_number].join("-")
+    end
+
   end
 
 end

data/lib/get_response/contact.rb

@@ -2,7 +2,7 @@ module GetResponse
 
   # GetResponse contact
   class Contact
-    attr_accessor :campaign, :name, :email, :cycle_day, :ip, :customs, :created_on, :deleted_on, :reason
+    attr_accessor :campaign, :name, :email, :cycle_day, :ip, :customs, :created_on, :deleted_on, :reason, :duplicated
     attr_reader :id
 
 
@@ -18,6 +18,7 @@ module GetResponse
       @deleted_on = params["deleted_on"]
       @reason = params["reason"]
       @connection = connection
+      @duplicated = false
     end
 
 
@@ -27,6 +28,7 @@ module GetResponse
     # returns:: Boolean
     def save
       result = @connection.send_request(:add_contact, self.attributes)
+      self.duplicated = true unless result["result"]["duplicated"].nil?
       result["error"].nil?
     end
 
@@ -37,13 +39,13 @@ module GetResponse
     def attributes
       attrs = {
         "campaign" => @campaign,
-        "name" => @name,
         "email" => @email
       }
 
       attrs["ip"] = @ip if @ip
       attrs["cycle_day"] = @cycle_day if @cycle_day
       attrs["customs"] = @customs if @customs
+      attrs["name"] = @name if @name
 
       attrs
     end

data/lib/get_response/contact_proxy.rb

@@ -19,10 +19,7 @@ module GetResponse
     # 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
+      build_contacts(response["result"])
     end
 
 
@@ -75,8 +72,18 @@ module GetResponse
     def deleted(conditions = {})
       conditions = parse_conditions(conditions)
       response = @connection.send_request("get_contacts_deleted", conditions)
-      response["result"].inject([]) do |contacts, resp|
-        contacts << Contact.new(resp[1].merge("id" => resp[0]), @connection)
+      build_contacts(response["result"])
+    end
+
+    private
+
+    # Build collection of <tt>Contact</tt> objects from service response.
+    #
+    # @param raw_contacts [Array] of Hashes parsed from GetResponse API response
+    # @return [Array]
+    def build_contacts(raw_contacts)
+      raw_contacts.map do |raw_contact|
+        Contact.new(raw_contact[1].merge("id" => raw_contact[0]), @connection)
       end
     end
 

data/lib/get_response/link.rb

@@ -0,0 +1,18 @@
+module GetResponse
+
+  # Class represents link embedded in GetResponse message.
+  class Link
+    attr_reader :message, :name, :url, :clicks
+
+    def initialize(attrs, connection)
+      @message = attrs["message"]
+      @name = attrs["name"]
+      @url = attrs["url"]
+      @clicks = attrs["clicks"]
+      @connection = connection
+    end
+
+  end
+
+end
+

data/lib/get_response/links_proxy.rb

@@ -0,0 +1,29 @@
+module GetResponse
+
+  # Proxy class for all links related actions.
+  class LinksProxy
+    include Conditions
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+
+    # Fetch all links, optionally you can pass a hash with conditions.
+    #
+    # Example:
+    #
+    #   @proxy.all("messages" => ["my_message_id", "my_second_message_id"])
+    #
+    # @return [Array] collection of links
+    def all(conditions = {})
+      conditions = parse_conditions(conditions)
+
+      @connection.send_request("get_links", conditions)["result"].map do |link_id, link_attrs|
+        Link.new(link_attrs.merge("id" => link_id), @connection)
+      end
+    end
+
+  end
+
+end

data/lib/get_response/message.rb

@@ -33,5 +33,14 @@ module GetResponse
       resp = @connection.send_request("get_message_stats", :message => @id)
       resp["result"]
     end
+
+
+    # Fetch links embedded in this message
+    #
+    # @return [Array] collection of links
+    def links
+      @connection.links.all("messages" => [@id])
+    end
+
   end
 end

metadata

@@ -1,133 +1,118 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: getresponse
-version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  version: "0.5"
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.5.1
 platform: ruby
-authors: 
+authors:
 - Sebastian Nowak
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-02 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        version: "1.4"
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json_pure
+      - !ruby/object:Gem::Version
+        version: '1.4'
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        version: "1.4"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  name: json
+- !ruby/object:Gem::Dependency
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  name: json_pure
+- !ruby/object:Gem::Dependency
   type: :development
-  version_requirements: *id003
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  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
 email: sebastian.nowak@implix.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/get_response/account.rb
-- lib/get_response/campaign.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
+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/connection.rb
-- lib/get_response/contact.rb
 - lib/get_response/contact_proxy.rb
-- lib/get_response/domain.rb
-- lib/get_response/domain_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/campaign.rb
+- lib/get_response/message.rb
+- lib/get_response/connection.rb
 - lib/get_response/follow_up.rb
-- lib/get_response/from_field.rb
+- lib/get_response/conditions.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/get_response/message.rb
-- lib/get_response/message_proxy.rb
-- lib/get_response/newsletter.rb
-- lib/get_response.rb
+- lib/api.rb
 - README.rdoc
-has_rdoc: true
 homepage: http://dev.getresponse.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 17
-      segments: 
-      - 1
-      - 3
-      - 5
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for GetResponse API
 test_files: []
-