dyn-rb 1.0.2

data/lib/dyn/http/patron.rb

@@ -0,0 +1,52 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'patron'
+
+module Dyn
+  module HttpClient
+    class PatronClient < Base
+      private
+
+      def fixup_request(original)
+        headers = original[:headers]
+
+        if !original[:body].nil? && headers["Content-Type"].nil?
+          headers = headers.merge({"Content-Type" => "application/x-www-form-urlencoded"})
+        end
+
+        original.merge({:headers => headers})
+      end
+
+      def perform_request(method, uri, body, headers)
+        options = {}
+        options[:data] = body unless body.nil?
+        options[:max_redirects] = 0
+        headers = headers ? headers : {}
+
+        response = Patron::Session.new.request(method.to_s.downcase.to_sym, @base_url + uri, headers, options)
+
+        Response.new(response.status, response.body, response.headers)
+      end
+    end
+    
+    unless defined?(DefaultClient)
+      class DefaultClient < Dynect::HttpClient::PatronClient
+      end
+    end
+  end
+end

data/lib/dyn/messaging.rb

@@ -0,0 +1,156 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Dyn
+  module Messaging
+    class Client
+      require 'uri'
+      require 'json'
+      require 'dyn/exceptions'
+      require 'dyn/messaging/senders'
+      require 'dyn/messaging/accounts'
+      require 'dyn/messaging/recipients'
+      require 'dyn/messaging/suppressions'
+      require 'dyn/messaging/delivery'
+      require 'dyn/messaging/sent_mail'
+      require 'dyn/messaging/bounces'
+      require 'dyn/messaging/complaints'
+      require 'dyn/messaging/issues'
+      require 'dyn/messaging/opens'
+      require 'dyn/messaging/clicks'
+      require 'dyn/messaging/send_mail'
+      require 'dyn/http/http_client'
+
+      unless defined?(Dyn::HttpClient::DefaultClient)
+        require 'dyn/http/net_http'
+      end
+
+      attr_accessor :apikey, :rest
+
+      # Creates a new base object for interacting with Dyn's REST API
+      #
+      # @param [String] Your dyn api key
+      # @param [Boolean] Verbosity
+      def initialize(apikey, verbose=false)
+        @apikey = apikey
+        @rest = Dyn::HttpClient::DefaultClient.new("emailapi.dynect.net", "443", "https")
+        @rest.default_headers = {
+          'User-Agent'   => 'dyn-rb 1.0.2',
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+        @verbose = verbose
+      end
+
+      ##
+      # Senders API
+      ##
+      def senders
+        Dyn::Messaging::Senders.new(self)
+      end
+
+      def accounts
+        Dyn::Messaging::Accounts.new(self)
+      end
+
+      def recipients
+        Dyn::Messaging::Recipients.new(self)
+      end
+
+      def suppressions
+        Dyn::Messaging::Suppressions.new(self)
+      end
+
+      def delivery
+        Dyn::Messaging::Delivery.new(self)
+      end
+
+      def sent_mail
+        Dyn::Messaging::SentMail.new(self)
+      end
+
+      def bounces
+        Dyn::Messaging::Bounces.new(self)
+      end
+
+      def complaints
+        Dyn::Messaging::Complaints.new(self)
+      end
+
+      def issues
+        Dyn::Messaging::Issues.new(self)
+      end
+
+      def opens
+        Dyn::Messaging::Opens.new(self)
+      end
+
+      def clicks
+        Dyn::Messaging::Clicks.new(self)
+      end
+
+      def send_mail
+        Dyn::Messaging::SendMail.new(self)
+      end
+
+      # Raw GET request, formatted for Dyn. See list of endpoints at:
+      #
+      # https://help.dynect.net/api/
+      #
+      # @param [String] The partial path to GET - for example, 'senders' or 'accounts'.
+      # @param [Hash] Query Parameters
+      # @param [Hash] Additional HTTP headers
+      def get(path_part, query_params = {}, additional_headers = {}, &block)
+        api_request { @rest.get("/rest/json/#{path_part}?" + URI.encode_www_form(query_params.merge({apikey:@apikey})), nil, additional_headers, &block) }
+      end
+
+      # Raw POST request, formatted for Dyn. See list of endpoints at:
+      #
+      # https://help.dynect.net/api/
+      #
+      # Read the API documentation, and submit the proper data structure from here.
+      #
+      # @param [String] The partial path to POST - for example, 'senders' or 'accounts'.
+      # @param [Hash] The data structure to submit as the body, is automatically turned to encoded Form POST
+      # @param [Hash] Additional HTTP headers
+      def post(path_part, form_params = {}, additional_headers = {}, &block)
+        api_request { @rest.post("/rest/json/#{path_part}", URI.encode_www_form(form_params.merge({apikey:@apikey})), additional_headers, &block) }
+      end
+
+      # Handles making Dynect API requests and formatting the responses properly.
+      def api_request(&block)
+        response_body = begin
+          response = block.call
+          response.body
+        rescue Exception => e
+          if @verbose
+            puts "I have #{e.inspect} with #{e.http_code}"
+          end
+          e.response
+        end
+        
+        response = JSON.parse(response_body || '{}')
+        
+        if (response["response"] && response["response"]["status"] == 200)
+          response["response"]["data"]
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/lib/dyn/messaging/accounts.rb

@@ -0,0 +1,53 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Dyn
+  module Messaging
+    class Accounts
+      def initialize(dyn)
+        @dyn = dyn
+      end
+
+      def list(startindex="0")
+        @dyn.get("#{resource_path}", {startindex:startindex})
+      end
+
+      def create(username, password, companyname, phone, address, city, state, zipcode, country, timezone, bounceurl, spamurl, unsubscribeurl, tracelinks, trackunsubscribes, generatenewapikey)
+        @dyn.post("#{resource_path}", {username:username, password:password, companyname:companyname, phone:phone, address:address, city:city, state:state, zipcode:zipcode, country:country, timezone:timezone, bounceurl:bounceurl, spamurl:spamurl, unsubscribeurl:unsubscribeurl, tracelinks:tracelinks, trackunsubscribes:trackunsubscribes, generatenewapikey:generatenewapikey})
+      end
+
+      def destroy(username)
+        @dyn.post("#{resource_path}/delete", {username:username})
+      end
+
+      def list_xheaders
+        @dyn.get("#{resource_path}/xheaders")
+      end
+
+      def update_xheaders(xh1, xh2, xh3, xh4)
+        @dyn.post("#{resource_path}/xheaders", {xheader1:xh1,xheader2:xh2,xheader3:xh3,xheader4:xh4})
+      end
+      
+      private
+      
+      def resource_path
+        "accounts"
+      end
+    end
+  end
+end

data/lib/dyn/messaging/bounces.rb

@@ -0,0 +1,41 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Dyn
+  module Messaging
+    class Bounces
+      def initialize(dyn)
+        @dyn = dyn
+      end
+
+      def count(starttime, endtime, sender, xheadername)
+        @dyn.get("#{resource_path}/count", {starttime:starttime, endtime:endtime, sender:sender, xheadername:xheadername})
+      end
+
+      def list(starttime, endtime, startindex=0, sender, email, bouncetype, noheaders, xheadername)
+        @dyn.get("#{resource_path}", {starttime:starttime, endtime:endtime, startindex:startindex, sender:sender, emailaddress:email, bouncetype:bouncetype, noheaders:noheaders, xheadername:xheadername})
+      end
+      
+      private
+      
+      def resource_path
+        "reports/bounces"
+      end
+    end
+  end
+end

data/lib/dyn/messaging/clicks.rb

@@ -0,0 +1,49 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Dyn
+  module Messaging
+    class Clicks
+      def initialize(dyn)
+        @dyn = dyn
+      end
+
+      def count(starttime, endtime, xheadername)
+        @dyn.get("#{resource_path}/count", {starttime:starttime, endtime:endtime, xheadername:xheadername})
+      end
+
+      def list(starttime, endtime, startindex=0, xheadername)
+        @dyn.get("#{resource_path}", {starttime:starttime, endtime:endtime, startindex:startindex, xheadername:xheadername})
+      end
+
+      def unique_count(starttime, endtime, xheadername)
+        @dyn.get("#{resource_path}/count/unique", {starttime:starttime, endtime:endtime, xheadername:xheadername})
+      end
+
+      def unique(starttime, endtime, startindex=0, xheadername)
+        @dyn.get("#{resource_path}/unique", {starttime:starttime, endtime:endtime, startindex:startindex, xheadername:xheadername})
+      end
+      
+      private
+      
+      def resource_path
+        "reports/clicks"
+      end
+    end
+  end
+end

data/lib/dyn/messaging/complaints.rb

@@ -0,0 +1,41 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Dyn
+  module Messaging
+    class Complaints
+      def initialize(dyn)
+        @dyn = dyn
+      end
+
+      def count(starttime, endtime, sender, xheadername)
+        @dyn.get("#{resource_path}/count", {starttime:starttime, endtime:endtime, sender:sender, xheadername:xheadername})
+      end
+
+      def list(starttime, endtime, startindex=0, sender, xheadername)
+        @dyn.get("#{resource_path}", {starttime:starttime, endtime:endtime, startindex:startindex, sender:sender, xheadername:xheadername})
+      end
+      
+      private
+      
+      def resource_path
+        "reports/complaints"
+      end
+    end
+  end
+end

data/lib/dyn/messaging/delivery.rb

@@ -0,0 +1,41 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Dyn
+  module Messaging
+    class Delivery
+      def initialize(dyn)
+        @dyn = dyn
+      end
+
+      def count(starttime, endtime, sender, xheadername)
+        @dyn.get("#{resource_path}/count", {starttime:starttime, endtime:endtime, sender:sender, xheadername:xheadername})
+      end
+
+      def list(starttime, endtime, startindex=0, sender, xheadername)
+        @dyn.get("#{resource_path}", {starttime:starttime, endtime:endtime, startindex:startindex, sender:sender, xheadername:xheadername})
+      end
+      
+      private
+      
+      def resource_path
+        "reports/delivered"
+      end
+    end
+  end
+end

data/lib/dyn/messaging/issues.rb

@@ -0,0 +1,41 @@
+#
+# Author:: Sunny Gleason (<sunny@thesunnycloud.com>)
+# Copyright:: Copyright (c) 2013 Dyn, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Dyn
+  module Messaging
+    class Issues
+      def initialize(dyn)
+        @dyn = dyn
+      end
+
+      def count(starttime, endtime)
+        @dyn.get("#{resource_path}/count", {starttime:starttime, endtime:endtime})
+      end
+
+      def list(starttime, endtime, startindex=0)
+        @dyn.get("#{resource_path}", {starttime:starttime, endtime:endtime, startindex:startindex})
+      end
+      
+      private
+      
+      def resource_path
+        "reports/issues"
+      end
+    end
+  end
+end