expresspigeon-ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 219e88febc4f6de2dec7d8688366a8ad687b8928
-  data.tar.gz: a060f8c93df2f5dc6329ea4b098eed97da24e310
+  metadata.gz: fefbb9b811e6290f8bee711c7999eee4863fbf2c
+  data.tar.gz: 226ce044ad36fc9e040765166957e60b55a86310
 SHA512:
-  metadata.gz: d24f13e62161c083a61437e14474f24552c37d64606e23adc3c0d0016837e08f004296af4ac1230f54bad9c0a1f85fe7415c9b19484823980417d122a7d75913
-  data.tar.gz: 84e93e5168cbfc8df275cc564e9b2b72feebc413a238a06b314f16de037530848c88b7de577a8a0ddacd70a4b6b6be6c2badc0f60a0c204f8552fe130c0ff094
+  metadata.gz: afddd1061ee740fbfaf728021ac668adf13fa9dcdc4da1b009a9cdfc5c5c04238c7a8e82a206820374bd08ac61494b0f19ecdb246688fce3f9da1b1e923d629a
+  data.tar.gz: f049b418b5e84d7664ad8e2d721d02b7fa7de7b3a2d2e14b069fd53188f854b5374389e01d46672b50a0da784c055fc971695991d24adcbc33f3444b5aa07d03

data/.gitignore

@@ -5,3 +5,5 @@
 
 rspec.sh
 set_env
+
+*.txt

data/.rvmrc

@@ -3,6 +3,6 @@ USER_RVMRC='.rvmrc.local'
 if [ -f $USER_RVMRC ]; then
   source $USER_RVMRC
 else
-  rvm use 2.1.5 --create
+  rvm use 2.1.1 --create
 fi
 

data/Gemfile.lock

@@ -1,12 +1,23 @@
 PATH
   remote: .
   specs:
-    expresspigeon-ruby (0.0.1)
+    expresspigeon-ruby (0.0.2)
+      rest-client (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    mime-types (1.25.1)
+    netrc (0.7.9)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -15,6 +26,9 @@ GEM
     rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -38,6 +38,8 @@ sleep 5
 
 # get a report for a specific message
 puts MESSAGES.report message_response.id
+```
+
 
 ## Contributing
 

data/expresspigeon-ruby.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |gem|
   gem.name          = "expresspigeon-ruby"
   gem.version       = Expresspigeon::API::VERSION
   gem.authors       = ["ipolevoy"]
-  gem.email         = ["ipolevoy@groupon.com"]
-  gem.description   = %q{ExpressPigeon Ruby API for sending transactional messages, manipulating lists, contacts nad more}
+  gem.email         = ["igor@expresspigeon.com"]
+  gem.description   = %q{ExpressPigeon Ruby API for sending transactional messages, manipulating lists, contacts and more}
   gem.summary       = %q{ExpressPigeon API Ruby Wrapper}
   gem.homepage      = "https://github.com/expresspigeon/expresspigeon-ruby"
 
@@ -16,5 +16,8 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'rest-client', '~> 1.8.0'
+
   gem.add_development_dependency "rspec", "~> 2.6"
 end

data/lib/express_pigeon/auto_responders.rb

@@ -0,0 +1,47 @@
+module ExpressPigeon
+  class AutoResponders
+    include ExpressPigeon::API
+
+    def initialize
+      @endpoint = 'auto_responders'
+    end
+
+    attr_reader :endpoint
+
+    # Get all autoresponders
+    #
+    # Returns an array of autoresponders.
+    #
+    # Docs: https://expresspigeon.com/api#auto_responders_get_all
+    #
+    def all
+      get endpoint
+    end
+
+    # Start for a contact
+    #
+    # This call starts an autoresponder for a contact.
+    #
+    # :param auto_responder_id: autoresponder id to be started for a contact
+    # :param email:             contact email
+    #
+    # Docs: https://expresspigeon.com/api#auto_responders_start
+    #
+    def start(auto_responder_id, email)
+      post "#{endpoint}/#{auto_responder_id}/start", email: email
+    end
+
+    # Stop for a contact
+    #
+    # This call stops an autoresponder for a contact.
+    #
+    # :param auto_responder_id: autoresponder id to be stopped for a contact
+    # :param email:             contact email
+    #
+    # Docs: https://expresspigeon.com/api#auto_responders_stop
+    #
+    def stop(auto_responder_id, email)
+      post "#{endpoint}/#{auto_responder_id}/stop", email: email
+    end
+  end
+end

data/lib/expresspigeon-ruby.rb

@@ -3,6 +3,7 @@ require "expresspigeon-ruby/version"
 require 'net/http'
 require 'json'
 require 'uri'
+require 'rest_client'
 
 module ExpressPigeon
 
@@ -25,16 +26,22 @@ module ExpressPigeon
 
     def http(path, method, params = {})
       root = @root ? @root : ROOT
+
+      if params and !params.empty? and method == 'Get'
+        query = URI.encode_www_form(params)
+        path = "#{path}?#{query}"
+      end
+
+
       uri = URI.parse "#{root}#{path}"
       req = Net::HTTP.const_get("#{method}").new "#{ROOT}#{path}"
-      unless AUTH_KEY ||  @auth_key
-        raise("Must set either EXPRESSPIGEON_AUTH_KEY as environment variable, or ExpressPigeon::AUTH_KEY in code")
-      end
 
-      req['X-auth-key'] = AUTH_KEY ? AUTH_KEY : @auth_key
+      req['X-auth-key'] = get_auth_key
       if params
-        req.body = params.to_json
-        req['Content-type'] = 'application/json'
+        if method != 'Get'
+          req.body = params.to_json
+          req['Content-type'] = 'application/json'
+        end
       end
 
       if block_given?
@@ -58,8 +65,16 @@ module ExpressPigeon
       end
     end
 
-    def get(path, &block)
-      http path, 'Get', nil, &block
+    def get_auth_key
+      unless AUTH_KEY ||  @auth_key
+        raise("Must set authentication key either using environment variable EXPRESSPIGEON_AUTH_KEY, or using auth_key() method in code")
+      end
+
+      @auth_key ? @auth_key : AUTH_KEY
+    end
+
+    def get(path, params = {}, &block)
+      http path, 'Get', params, &block
     end
 
     def post(path, params = {})
@@ -85,234 +100,23 @@ module ExpressPigeon
     def self.messages
       Messages.new
     end
-  end
-
-end
 
-class MetaHash < Hash
-
-  def initialize(delegate)
-    super
-    @delegate = delegate
-    @delegate.each_key do |k|
-      v = @delegate[k] # lets go only one level down for now
-      if v.kind_of? Hash
-        @delegate[k] = MetaHash.new(v)
-      end
+    def self.auto_responders
+      AutoResponders.new
     end
-  end
-
-  def method_missing(m, *args, &block)
-    @delegate[m.to_s]
-  end
-
-  def to_s
-    @delegate.to_s
-  end
-
-end
-
-class Lists
-
-  include ExpressPigeon::API
-
-  def initialize
-    @endpoint = 'lists'
-  end
-
-  def create(list_name, from_name, reply_to)
-    post @endpoint, {:name => list_name, :from_name => from_name, :reply_to => reply_to}
-  end
-
-
-  # Query all lists.
-  # returns: array of hashes each representing a list for this user
-  def all
-    get @endpoint
-  end
-
-
-  #Updates existing list
-  #
-  #:param list_id: Id of list to be updated
-  #:type list_id: int
-  #
-  #:param params: JSON object represents a list to be updated
 
-  #
-  #:returns: EpResponse with status, code, message, and updated list
-  #:rtype: EpResponse
-  #TODO: resolve API on Python side, then implement this
-  #def update(list_id, params = {})
-  #    params['id'] = list_id
-  #    return self.ep.put(self.endpoint, params=params)
-  #end
-
-
-  # Removes a list with a given id. A list must be enabled and has no dependent subscriptions and/or scheduled campaigns.
-  #
-  #  param list_id: Id of list to be removed.
-  #  returns response hash with status, code, and message
-  def delete(list_id)
-    del "#{@endpoint}/#{list_id}"
-  end
-
-  def csv(list_id, &block)
-    get "#{@endpoint}/#{list_id}/csv", &block
-  end
-
-
-end
-
-class Campaigns
-  include ExpressPigeon::API
-
-  def initialize
-    @endpoint = 'campaigns'
-  end
-
-  def all
-    get @endpoint
-  end
-
-  def report(campaign_id)
-    get "#{@endpoint}/#{campaign_id}"
-  end
-
-  def bounced(campaign_id)
-    get "#{@endpoint}/#{campaign_id}/bounced"
-  end
-
-  def unsubscribed(campaign_id)
-    get "#{@endpoint}/#{campaign_id}/unsubscribed"
-  end
-
-  def spam(campaign_id)
-    get "#{@endpoint}/#{campaign_id}/spam"
-  end
-
-  #
-  # Schedules a new campaign to be sent.
-  # Parameters:
-  # * *list_id* - id of list to send to
-  # * *template_id* - id of template to send
-  # * *name* - name of a newly created campaign
-  # * *from_name* - from name
-  # * *reply_to* - reply to
-  # * *subject* - subject of campaign
-  # * *google_analytics* - true to turn Google Analytics on
-  def send(params = {})
-    post @endpoint, params
-  end
-
-  #
-  # Schedules a new campaign to be sent.
-  # Parameters:
-  # * *list_id* - id of list to send to
-  # * *template_id* - id of template to send
-  # * *name* - name of a newly created campaign
-  # * *from_name* - from name
-  # * *reply_to* - reply to
-  # * *subject* - subject of campaign
-  # * *google_analytics* - true to turn Google Analytics on
-  # * *schedule_for* - Specifies what time a campaign should be sent. If it is provided the campaign will
-  #                     be scheduled to this time, otherwise campaign is sent immediately. The schedule_for
-  #                     must be in ISO date format and should be in the future.
-  def schedule(params = {})
-    post @endpoint, params
-  end
-end
-
-
-class Contacts
-  include ExpressPigeon::API
-
-  def initialize
-    @endpoint = 'contacts'
-  end
-
-  def find_by_email(email)
-    get "#{@endpoint}?email=#{email}"
-  end
-
-
-  # JSON document represents a contact to be created or updated.
-  # The email field is required.
-  # When updating a contact, list_id is optional,
-  # since the contact is uniquely identified by email across all lists.
-  #
-  # :param list_id: Contact list ID (Fixnum) the contact will be added to
-  #
-  # :param contact: Hash describes new contact. The "email" field is required.
-  #
-  # :returns: representation of a contact
-  #
-  def upsert(list_id, contact)
-    post @endpoint, params = {:list_id => list_id, :contact => contact}
-  end
-
-  # Delete single contact. If list_id is not provided, contact will be deleted from system.
-  # :param email: contact email to be deleted.
-  # :param list_id: list id to remove contact from, if not provided, contact will be deleted from system.
-  def delete(email, list_id = nil)
-    if list_id
-      query = "email=#{email}&list_id=#{list_id}"
-    else
-      query = "email=#{email}"
+    def self.templates
+      Templates.new
     end
-    del "#{@endpoint}?#{query}", nil
   end
 
-
 end
-class Messages
-
-  include ExpressPigeon::API
-
-  def initialize
-    @endpoint = 'messages'
-  end
-
-  def send_message(template_id, to, reply_to, from_name, subject, merge_fields = nil, view_online = false, click_tracking = true)
-    post @endpoint, params = {template_id: template_id, :to => to, reply_to: reply_to, :from => from_name, :subject => subject,
-                              :merge_fields => merge_fields, :view_online => view_online, :click_tracking => click_tracking}
-  end
-
-  def report(message_id)
-    get "#{@endpoint}/#{message_id}"
-  end
-
-  #
-  #
-  # start_date is instance of Time
-  # end_date is instance of Time
-  def reports(from_id, start_date = nil, end_date = nil)
-    params = []
 
-    if from_id
-      params << "from_id=#{from_id}"
-    end
-
-    if start_date and not end_date
-      raise 'must include both start_date and end_date'
-    end
-    if end_date and not start_date
-      raise 'must include both start_date and end_date'
-    end
-
-    if start_date and end_date
-      params << "start_date=#{start_date.strftime('%FT%T.%L%z')}"
-      params << "end_date=#{end_date.strftime('%FT%T.%L%z')}"
-    end
+require_relative 'expresspigeon-ruby/meta_hash'
+require_relative 'expresspigeon-ruby/lists'
+require_relative 'expresspigeon-ruby/campaigns'
+require_relative 'expresspigeon-ruby/contacts'
+require_relative 'expresspigeon-ruby/messages'
+require_relative 'expresspigeon-ruby/templates'
 
-    query = "#{@endpoint}?"
-
-    if params.size > 0
-      query << params.join('&')
-    end
-
-    puts "calling: #{query}"
-    get query
-
-  end
-end
+require_relative 'express_pigeon/auto_responders'

data/lib/expresspigeon-ruby/campaigns.rb

@@ -0,0 +1,64 @@
+module ExpressPigeon
+  class Campaigns
+    include ExpressPigeon::API
+
+    def initialize
+      @endpoint = 'campaigns'
+    end
+
+    def all (params ={})
+      get @endpoint, params
+    end
+
+    def report(campaign_id)
+      get "#{@endpoint}/#{campaign_id}"
+    end
+
+    def bounced(campaign_id)
+      get "#{@endpoint}/#{campaign_id}/bounced"
+    end
+
+    def unsubscribed(campaign_id)
+      get "#{@endpoint}/#{campaign_id}/unsubscribed"
+    end
+
+    def spam(campaign_id)
+      get "#{@endpoint}/#{campaign_id}/spam"
+    end
+
+    #
+    # Schedules a new campaign to be sent.
+    # Parameters:
+    # * *list_id* - id of list to send to
+    # * *template_id* - id of template to send
+    # * *name* - name of a newly created campaign
+    # * *from_name* - from name
+    # * *reply_to* - reply to
+    # * *subject* - subject of campaign
+    # * *google_analytics* - true to turn Google Analytics on
+    def send(params = {})
+      post @endpoint, params
+    end
+
+    #
+    # Schedules a new campaign to be sent.
+    # Parameters:
+    # * *list_id* - id of list to send to
+    # * *template_id* - id of template to send
+    # * *name* - name of a newly created campaign
+    # * *from_name* - from name
+    # * *reply_to* - reply to
+    # * *subject* - subject of campaign
+    # * *google_analytics* - true to turn Google Analytics on
+    # * *schedule_for* - Specifies what time a campaign should be sent. If it is provided the campaign will
+    #                     be scheduled to this time, otherwise campaign is sent immediately. The schedule_for
+    #                     must be in ISO date format and should be in the future.
+    def schedule(params = {})
+      post @endpoint, params
+    end
+
+    def delete(campaign_id)
+      del "#{@endpoint}/#{campaign_id}"
+    end
+  end
+end