emaildirect 1.0.1 → 1.1.0

data/HISTORY.md

@@ -0,0 +1,9 @@
+## 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.
+* 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.
+
+## 1.0.0 (Dec. 12th, 2011)
+
+* Initial release

data/README.md

@@ -7,7 +7,7 @@ A ruby library which implements the complete functionality of the REST (v5) [Ema
 ### Plain ruby
     gem install emaildirect
     require 'emaildirect'
-    EmailDirect.api_key 'your_api_key'
+    EmailDirect.api_key = 'your_api_key'
 
 ### Rails integration
 In your gemfile:
@@ -16,7 +16,7 @@ In your gemfile:
 
 In an initializer:
 
-    EmailDirect.api_key 'your_api_key'
+    EmailDirect.api_key = 'your_api_key'
 
 ## Examples
 
@@ -37,6 +37,20 @@ Results in:
     sub = EmailDirect::Publication.new(response.publicationID)
     sub.delete
 
+### Updating a subscriber's custom fields
+
+A single attribute:
+
+    EmailDirect::Subscriber.new(email).update_custom_field :FirstName, 'Pat'
+
+Multiple attributes:
+
+    EmailDirect::Subscriber.new(email).update_custom_fields :FirstName => 'Pam', :LastName => 'Sinivas'
+
+When creating a subscriber
+
+    EmailDirect::Subscriber.create(email, :Publications => [1], :CustomFields => { :FirstName => 'Pam', :LastName => 'Sinivas' }
+
 ### ActionMailer integration
 You can use send your ActionMailer email through Email Direct using their Relay Send functionality by setting up a new delivery method in an initalizer:
 

data/lib/emaildirect.rb

@@ -27,14 +27,14 @@ require 'emaildirect/suppression_list'
 require 'emaildirect/workflow'
 
 module EmailDirect
-  # Just allows callers to do EmailDirect.api_key "..." rather than EmailDirect::EmailDirect.api_key "..." etc
+  # Just allows callers to do EmailDirect.api_key = "..." rather than EmailDirect::EmailDirect.api_key "..." etc
   class << self
-    def api_key(api_key=nil)
-      r = EmailDirect.api_key api_key
+    def api_key=(api_key=nil)
+      EmailDirect.api_key api_key
     end
     
-    def base_uri(uri)
-      r = EmailDirect.base_uri uri
+    def base_uri=(uri)
+      EmailDirect.base_uri uri
     end
   end
 
@@ -62,15 +62,16 @@ module EmailDirect
     headers({ 
       'User-Agent' => "emaildirect-rest-#{VERSION}",
       'Content-Type' => 'application/json; charset=utf-8',
-      'Accept-Encoding' => 'gzip, deflate' })
+      'Accept-Encoding' => 'gzip, deflate',
+      'ApiKey' => @@api_key
+    })
     base_uri @@base_uri
-    basic_auth 'x', @@api_key
 
     # Sets the API key which will be used to make calls to the EmailDirect API.
-    def self.api_key(api_key=nil)
+    def self.api_key(api_key = nil)
       return @@api_key unless api_key
       @@api_key = api_key
-      basic_auth 'x', @@api_key
+      headers 'ApiKey' => @@api_key
     end
 
     # This call returns an object reflecting the current permissions allowed for the provided API Key

data/lib/emaildirect/subscriber.rb

@@ -27,9 +27,18 @@ module EmailDirect
 
       def create(email, options = {})
         options.merge! :EmailAddress => email
+        self.convert_custom_fields options
         response = EmailDirect.post '/Subscribers', :body => options.to_json
         Hashie::Mash.new(response)
       end
+
+      protected
+
+      def convert_custom_fields(options)
+        if options.has_key?(:CustomFields) && options[:CustomFields].is_a?(Hash)
+          options[:CustomFields] = options[:CustomFields].map { |k, v| { :FieldName => k, :Value => v } }
+        end
+      end
     end
 
     attr_reader :email
@@ -55,10 +64,19 @@ module EmailDirect
 
     def update(options)
       options.merge! :EmailAddress => email
+      self.class.convert_custom_fields options
       response = EmailDirect.put uri_for, :body => options.to_json
       Hashie::Mash.new(response)
     end
 
+    def update_custom_field(attribute, value)
+      self.class.create email, :CustomFields => [ { :FieldName => attribute, :Value => value } ]
+    end
+
+    def update_custom_fields(attributes)
+      self.class.create email, :CustomFields => attributes
+    end
+
     def delete
       response = EmailDirect.delete uri_for, {}
       Hashie::Mash.new(response)

data/lib/emaildirect/version.rb

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

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: emaildirect
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jason Rust
@@ -14,45 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-13 00:00:00 -08:00
+date: 2011-12-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  name: json
-  prerelease: false
-  requirement: *id001
   type: :runtime
+  name: json
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  name: hashie
-  prerelease: false
-  requirement: *id002
   type: :runtime
+  name: hashie
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  name: httparty
-  prerelease: false
-  requirement: *id003
   type: :runtime
+  name: httparty
+  version_requirements: *id003
 description: Implements the complete functionality of the email direct REST API.
 email: 
 - rustyparts@gmail.com
@@ -66,6 +73,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -103,16 +111,20 @@ rdoc_options: []
 require_paths: 
 - lib
 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 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3
@@ -121,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: A library which implements the complete functionality of of the emaildirect REST API (v5).