express_pigeon 1.0.4 → 2.0.0

data/lib/express_pigeon/api.rb

@@ -0,0 +1,66 @@
+# require_relative 'api/campaign'
+# require_relative 'api/contact'
+# require_relative 'api/list'
+# require_relative 'api/message'
+#
+# module ExpressPigeon
+#   module API
+#     def http(path, method, params = {})
+#       uri = URI.parse "#{ROOT}#{path}"
+#       req = Net::HTTP.const_get("#{method}").new "#{ROOT}#{path}"
+#       req['X-auth-key'] = AUTH_KEY
+#       if params
+#         req.body = params.to_json
+#         req['Content-type'] = 'application/json'
+#       end
+#
+#       if block_given?
+#         Net::HTTP.start(uri.host, uri.port, use_ssl: USE_SSL) do |http|
+#           http.request req do |res|
+#             res.read_body do |seg|
+#               yield seg
+#             end
+#           end
+#         end
+#       else
+#         resp = Net::HTTP.start(uri.host, uri.port, use_ssl: USE_SSL) do |http|
+#           http.request req
+#         end
+#         parsed = JSON.parse(resp.body)
+#         if parsed.is_a? Hash
+#           MetaHash.new parsed
+#         else
+#           parsed
+#         end
+#       end
+#     end
+#
+#     def get(path, &block)
+#       http path, 'Get', nil, &block
+#     end
+#
+#     def post(path, params = {})
+#       http path, 'Post', params
+#     end
+#
+#     def del(path, params = {})
+#       http path, 'Delete', params
+#     end
+#
+#     def self.campaigns
+#       Campaigns.new
+#     end
+#
+#     def self.lists
+#       Lists.new
+#     end
+#
+#     def self.contacts
+#       Contacts.new
+#     end
+#
+#     def self.messages
+#       Messages.new
+#     end
+#   end
+# end

data/lib/express_pigeon/contacts.rb

@@ -0,0 +1,71 @@
+module ExpressPigeon
+  # Contacts
+  #
+  # Contacts end point allows you to create, read, update and delete contacts
+  # on your lists. A contact consists of required email and various standard
+  # and custom fields.
+  class Contacts
+    include HTTParty
+
+    base_uri('https://api.expresspigeon.com/contacts')
+    debug_output(nil)
+
+    def initialize(auth_key)
+      self.class.headers('X-auth-key' => auth_key)
+    end
+
+    # Read a single contact by email
+    #
+    # GET https://api.expresspigeon.com/contacts
+    def find(email_address)
+      self.class.get('/', query: { email: email_address })
+    end
+
+    # Create or update contacts
+    #
+    # POST https://api.expresspigeon.com/contacts
+    def create(list_id, contacts)
+      fail "Contacts must be an Array received #{contacts.class.name}." unless contacts.is_a?(Array)
+
+      options = {
+        'list_id' => list_id,
+        'contacts' => contacts
+      }
+
+      self.class.post(
+        '/',
+        body: options.to_json,
+        headers: {
+          'Content-Type' => 'application/json'
+        }
+      )
+    end
+    alias_method :update, :create
+
+    # Delete a single contact
+    #
+    # DELETE https://api.expresspigeon.com/contacts
+    def delete(_email_address)
+    end
+
+    # Move contacts between lists
+    #
+    # POST https://api.expresspigeon.com/contacts/move
+    def move(source_list_id, target_list_id, email_addresses)
+      fail "Email address must be an Array received #{email_addresses.class.name}." unless email_addresses.is_a?(Array)
+
+      options = {}
+      options['source_list'] = source_list_id
+      options['target_list'] = target_list_id
+      options['contacts'] =  email_addresses
+
+      self.class.post(
+        '/move',
+        body: options.to_json,
+        headers: {
+          'Content-Type' => 'application/json'
+        }
+      )
+    end
+  end
+end

data/lib/express_pigeon/lists.rb

@@ -0,0 +1,111 @@
+module ExpressPigeon
+  # Lists
+  #
+  # Lists are sets of contacts a campaign can be sent to. A list consists of
+  # name, from name, reply-to fields and physical address that will be
+  # displayed in newsletter. Lists can be created, read, updated, deleted and
+  # filled up with contacts.
+  #
+  # Note: each list has properties, including physical address. Such address
+  # is merged into footers of newsletters when campaigns are sent to a list.
+  # It allows to send to different lists of contacts and display different
+  # physical addresses at the bottom of newsletters depending which list such
+  # email was sent to. This is a useful feature for agencies who manage email
+  # marketing campaigns on behalf of their clients.
+  class Lists
+    include HTTMultiParty
+
+    base_uri('https://api.expresspigeon.com/lists')
+    debug_output(nil)
+
+    def initialize(auth_key)
+      self.class.headers('X-auth-key' => auth_key)
+    end
+
+    # Create a new list
+    # POST https://api.expresspigeon.com/lists
+    #
+    # name:      Name of a newly created list
+    # from_name: Default "from" name used when sending campaigns to this list
+    # reply_to:  Default reply To email address used when sending campaigns to this list
+    def create(name:, from_name:, reply_to:)
+      self.class.post(
+        '/',
+        body: {
+          name: name,
+          from_name: from_name,
+          reply_to: reply_to
+        }.to_json,
+        headers: {
+          'Content-Type' => 'application/json'
+        }
+      )
+    end
+
+    # Check the status of list upload
+    # GET https://api.expresspigeon.com/lists/upload_status/{upload_id}
+    def upload_status(upload_id)
+      self.class.get("/upload_status/#{upload_id}")
+    end
+
+    # Get all lists
+    # GET https://api.expresspigeon.com/lists
+    def index
+      self.class.get('/')
+    end
+
+    # Upload contacts to list
+    # POST https://api.expresspigeon.com/lists/{list_id}/upload
+    def upload(list_id, path)
+      fail "No file found at '#{path}'." unless File.exist?(path)
+
+      self.class.post(
+        "/#{list_id}/upload",
+        query: { contacts_file: File.new(path, 'r') },
+        detect_mime_type: true
+      )
+    end
+
+    # Delete a list
+    # DELETE https://api.expresspigeon.com/lists/{list_id}
+    def delete(list_id)
+      self.class.delete("/#{list_id}")
+    end
+
+    # Download contacts from list
+    # GET https://api.expresspigeon.com/lists/{list_id}/csv
+    def download_csv(list_id, download_path)
+      fail "File found at '#{download_path}' but will not overwrite." if File.exist?(download_path)
+
+      response = self.class.get("/#{list_id}/csv")
+
+      File.open(download_path, 'wb') do |f|
+        f.write response.body
+      end
+
+      response
+    end
+
+    # Update existing list
+    # PUT https://api.expresspigeon.com/lists
+    def update(list_id, name: nil, from_name: nil, reply_to: nil)
+      options = {}
+      options['name'] = name unless name.nil?
+      options['from_name'] = from_name unless from_name.nil?
+      options['reply_to'] = reply_to unless reply_to.nil?
+
+      # if we didn't provide any options then it's a NOOP
+      return nil if options.empty?
+
+      options['id'] = list_id
+
+      self.class.put(
+        '/',
+        body: options.to_json,
+        headers: {
+          'Content-Type' => 'application/json'
+        }
+      )
+    end
+  end
+end

data/lib/express_pigeon/meta_hash.rb

@@ -0,0 +1,20 @@
+# 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.is_a? Hash
+#         @delegate[k] = MetaHash.new(v)
+#       end
+#     end
+#   end
+#
+#   def method_missing(m, *_args, &_block)
+#     @delegate[m.to_s]
+#   end
+#
+#   def to_s
+#     @delegate.to_s
+#   end
+# end

data/lib/express_pigeon/templates.rb

@@ -0,0 +1,4 @@
+module ExpressPigeon
+  class Templates
+  end
+end

data/lib/express_pigeon/transactional_emails.rb

@@ -0,0 +1,4 @@
+module ExpressPigeon
+  class TransactionalEmails
+  end
+end

data/lib/express_pigeon/version.rb

@@ -1,3 +1,3 @@
 module ExpressPigeon
-  VERSION = "1.0.4"
+  VERSION = '2.0.0'.freeze
 end