emaildirect 1.1.0 → 1.2.0

data/HISTORY.md

@@ -1,6 +1,9 @@
+## 1.2.0 (Dec. 21st, 2011)
+* Add EmailDirect.disable to disable talking to the EmailDirect server (requires fakeweb gem).
+
 ## 1.1.0 (Dec. 20th, 2011)
 
-* Added EmailDirect::Subscriber#update_custom_field and EmailDirect::Subscriber#update_custom_fields as a way to quickly update one or more custom fields.
+* Add EmailDirect::Subscriber#update_custom_field and EmailDirect::Subscriber#update_custom_fields as a way to quickly update one or more custom fields.
 * Custom Fields can now be passed as a regular ruby hash to any of the Subscriber methods and it will be converted to the correct JSON format.
 * Authentication is done using a header instead of basic auth so FakeWeb is easier to use.
 

data/README.md

@@ -88,6 +88,11 @@ Results in:
     Error Code:    101
     Error Message: Invalid Email Address
 
+### Disabling in Development/Test
+A helper method is provided to disable talking to the EmailDirect REST server (requires the [Fakeweb gem](http://fakeweb.rubyforge.org/))
+
+    EmailDirect.disable
+
 ### Expected input and output
 The best way of finding out the expected input and output of a particular method in a particular class is to read the [API docs](https://docs.emaildirect.com)
 and take a look at the code for that function.

data/lib/emaildirect.rb

@@ -27,15 +27,21 @@ require 'emaildirect/suppression_list'
 require 'emaildirect/workflow'
 
 module EmailDirect
-  # Just allows callers to do EmailDirect.api_key = "..." rather than EmailDirect::EmailDirect.api_key "..." etc
   class << self
-    def api_key=(api_key=nil)
-      EmailDirect.api_key api_key
+    # Just allows callers to do EmailDirect.api_key = "..." rather than EmailDirect::EmailDirect.api_key "..." etc
+    def api_key=(api_key)
+      EmailDirect.api_key = api_key
     end
     
     def base_uri=(uri)
       EmailDirect.base_uri uri
     end
+
+    # Allows the initializer to turn off actually communicating to the REST service for certain environments
+    # Requires fakeweb gem to be installed
+    def disable
+      FakeWeb.register_uri(:any, %r|#{Regexp.escape(EmailDirect.base_uri)}|, :body => '{"Disabled":true}', :content_type => 'application/json; charset=utf-8')
+    end
   end
 
   # Represents a EmailDirect API error and contains specific data about the error.
@@ -67,11 +73,37 @@ module EmailDirect
     })
     base_uri @@base_uri
 
-    # Sets the API key which will be used to make calls to the EmailDirect API.
-    def self.api_key(api_key = nil)
-      return @@api_key unless api_key
-      @@api_key = api_key
-      headers 'ApiKey' => @@api_key
+    class << self
+      # Sets the API key which will be used to make calls to the EmailDirect API.
+      def api_key=(api_key)
+        return @@api_key unless api_key
+        @@api_key = api_key
+        headers 'ApiKey' => @@api_key
+      end
+
+      def base_uri; @@base_uri end
+
+      def get(*args); handle_response super end
+      def post(*args); handle_response super end
+      def put(*args); handle_response super end
+      def delete(*args); handle_response super end
+
+      def handle_response(response) # :nodoc:
+        case response.code
+        when 400
+          raise BadRequest.new(Hashie::Mash.new response)
+        when 401
+          raise Unauthorized.new
+        when 404
+          raise NotFound.new
+        when 400...500
+          raise ClientError.new response.parsed_response
+        when 500...600
+          raise ServerError.new
+        else
+          response
+        end
+      end
     end
 
     # This call returns an object reflecting the current permissions allowed for the provided API Key
@@ -79,27 +111,5 @@ module EmailDirect
       response = EmailDirect.get('/Ping')
       Hashie::Mash.new(response)
     end
-
-    def self.get(*args); handle_response super end
-    def self.post(*args); handle_response super end
-    def self.put(*args); handle_response super end
-    def self.delete(*args); handle_response super end
-
-    def self.handle_response(response) # :nodoc:
-      case response.code
-      when 400
-        raise BadRequest.new(Hashie::Mash.new response)
-      when 401
-        raise Unauthorized.new
-      when 404
-        raise NotFound.new
-      when 400...500
-        raise ClientError.new response.parsed_response
-      when 500...600
-        raise ServerError.new
-      else
-        response
-      end
-    end
   end
 end

data/lib/emaildirect/version.rb

@@ -1,3 +1,3 @@
 module EmailDirect
-  VERSION = "1.1.0" unless defined?(EmailDirect::VERSION)
+  VERSION = "1.2.0" unless defined?(EmailDirect::VERSION)
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: emaildirect
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Jason Rust
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-20 00:00:00 -08:00
+date: 2011-12-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency