planet_express 0.0.3 → 0.0.7

data/.gitignore

@@ -9,7 +9,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+Changelog
+=========
+
+### 0.0.7
+- If Rails.logger exists use it, if not switch to log4r.
+
+### 0.0.6
+- Start using log4r instead of Logger.new (now logs are namespaced)
+- Minor changes to README and documentation. Added Changelog and silverpop api.
+- Adding name spaced exceptions to handle custom errors.
+
+### 0.0.5
+- Start using job.configure { } to change the Silverpop gateway url.
+- Start using Pry instead of IRB.
+- Start using Awesome Print instead of inspect.
+
+### 0.0.4
+- Minor changes to README and documentation.
+
+### 0.0.3
+- First usable version. Seems to be working.
+
+### 0.0.2
+- Adding a few clasess, still a mess.
+
+### 0.0.1
+- Empty gem using bundler's boilerplate.
+
+TODO
+----
+
+- Include Yard for documentation http://yardoc.org
+- Let change the gateway from the Class, instead from the instance

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    planet_express (0.0.3)
+    planet_express (0.0.7)
       activesupport
       hpricot
+      log4r
 
 GEM
   remote: http://rubygems.org/
@@ -11,6 +12,8 @@ GEM
     activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    awesome_print (1.1.0)
+    coderay (1.0.8)
     diff-lcs (1.1.3)
     guard (1.4.0)
       listen (>= 0.4.2)
@@ -24,7 +27,13 @@ GEM
     hpricot (0.8.6)
     i18n (0.6.1)
     listen (0.5.3)
-    multi_json (1.3.6)
+    log4r (1.1.10)
+    method_source (0.7.1)
+    multi_json (1.3.7)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
     rb-fsevent (0.9.2)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
@@ -35,16 +44,19 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
     ruby_gntp (0.3.4)
+    slop (2.4.4)
     thor (0.16.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   guard
   guard-bundler
   guard-rspec
   planet_express!
+  pry
   rb-fsevent
   rspec
   ruby_gntp

data/README.md

@@ -1,118 +1,55 @@
 Planet Express.rb
 =================
 
+Description
+-----------
+
 Planet Express, Inc. is an intergalactic email delivery <strike>company</strike>
 lib built in Ruby. Is meant to be used with Silverpop mailing system, to provide
 an easy way to send emails. We're using it with Rails 3 apps.
 
 > "Our crew is replaceable. Your <strike>package</strike> email isn't."
 
-**@MarioZaizar**
-
-## Installation
----------------
+Features
+--------
 
-Add this line to your application's Gemfile:
+- Send emails using Silverpop.
 
-```
-gem 'planet_express'
-```
-
-And then execute:
-
-```
-$ bundle
-```
-
-Or install it yourself as:
-
-```
-$ gem install planet_express
-```
-
-Usage
------
+### Examples
 
 You only need three things, the package, the destination and the data.
+Then create a new deliver, prepare the ship and deliver it!
 
 ```
+require 'planet_express'
+
 recipient  = 'mariozaizar@gmail.com'
 package_id = 1807752
-cargo      = {
-  fist_name: 'Mario',
-  last_name: 'Zaizar',
-  bill_float_test_body: "<h1>Good news everyone!</h1><img src='http://goo.gl/XazeH'>"
-}
-```
+cargo      = { bill_float_test_body: "<h1>Good news everyone!</h1><img src='http://goo.gl/XazeH'>" }
 
-Then create a new deliver, prepare the ship and deliver it!
-
-```
 job = PlanetExpress::Delivery.new
 request   = job.prepare package_id, recipient, cargo
 response  = job.deliver!
 ```
 
-Silverpop API
--------------
-
-We're using this <https://transact5.silverpop.com/XTMail> end point.
-
-### Request:
+### Configuration
 
 ```
-<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
-<XTMAILING>
-  <CAMPAIGN_ID>1807752</CAMPAIGN_ID>
-  <SHOW_ALL_SEND_DETAIL>true</SHOW_ALL_SEND_DETAIL>
-  <SEND_AS_BATCH>false</SEND_AS_BATCH>
-  <NO_RETRY_ON_FAILURE>false</NO_RETRY_ON_FAILURE>
-  <RECIPIENT>
-    <EMAIL>mariozaizar@gmail.com</EMAIL>
-    <BODY_TYPE>HTML</BODY_TYPE>
-    <PERSONALIZATION>
-      <TAG_NAME>first_name</TAG_NAME>
-      <VALUE><![CDATA[Mario]]></VALUE>
-    </PERSONALIZATION>
-    <PERSONALIZATION>
-      <TAG_NAME>last_name</TAG_NAME>
-      <VALUE><![CDATA[Zaizar]]></VALUE>
-    </PERSONALIZATION>
-  </RECIPIENT>
-</XTMAILING>
+job.configure do |config|
+  config.gateway_url = 'https://transact3.silverpop.com/XTMail'
+end
 ```
 
-### Response:
+Installation
+------------
 
-Succcess:
+Add this line to your application's Gemfile `gem 'planet_express'` and then
+execute `bundle install`. Or install it yourself as: `gem install planet_express`.
 
-```
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<XTMAILING_RESPONSE>
-  <CAMPAIGN_ID>1807752</CAMPAIGN_ID>
-  <RECIPIENTS_RECEIVED>1</RECIPIENTS_RECEIVED>
-  <EMAILS_SENT>1</EMAILS_SENT>
-  <NUMBER_ERRORS>0</NUMBER_ERRORS>
-  <STATUS>0</STATUS>
-  <ERROR_CODE></ERROR_CODE>
-  <ERROR_STRING></ERROR_STRING>
-</XTMAILING_RESPONSE>
-```
-
-When something is wrong:
+Silverpop API
+-------------
 
-```
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<XTMAILING_RESPONSE>
-  <CAMPAIGN_ID>1807752</CAMPAIGN_ID>
-  <RECIPIENTS_RECEIVED>1</RECIPIENTS_RECEIVED>
-  <EMAILS_SENT>0</EMAILS_SENT>
-  <NUMBER_ERRORS>1</NUMBER_ERRORS>
-  <STATUS>2</STATUS>
-  <ERROR_CODE>2</ERROR_CODE>
-  <ERROR_STRING>something wrong!</ERROR_STRING>
-</XTMAILING_RESPONSE>
-```
+Check this file: [doc/silverpop_api.md](./doc/silverpop_api.md)
 
 Contributing
 ------------
@@ -122,3 +59,5 @@ Contributing
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+**@MarioZaizar**

data/doc/silverpop_api.md

@@ -0,0 +1,79 @@
+Silverpop API
+-------------
+
+We're using this <https://transact5.silverpop.com/XTMail> end point.
+
+### Request:
+
+```
+<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
+<XTMAILING>
+  <CAMPAIGN_ID>1807752</CAMPAIGN_ID>
+  <SHOW_ALL_SEND_DETAIL>true</SHOW_ALL_SEND_DETAIL>
+  <SEND_AS_BATCH>false</SEND_AS_BATCH>
+  <NO_RETRY_ON_FAILURE>false</NO_RETRY_ON_FAILURE>
+  <RECIPIENT>
+    <EMAIL>mariozaizar@gmail.com</EMAIL>
+    <BODY_TYPE>HTML</BODY_TYPE>
+    <PERSONALIZATION>
+      <TAG_NAME>first_name</TAG_NAME>
+      <VALUE><![CDATA[Mario]]></VALUE>
+    </PERSONALIZATION>
+    <PERSONALIZATION>
+      <TAG_NAME>last_name</TAG_NAME>
+      <VALUE><![CDATA[Zaizar]]></VALUE>
+    </PERSONALIZATION>
+  </RECIPIENT>
+</XTMAILING>
+```
+
+### Response:
+
+Succcess:
+
+```
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<XTMAILING_RESPONSE>
+  <CAMPAIGN_ID>1807752</CAMPAIGN_ID>
+  <RECIPIENTS_RECEIVED>1</RECIPIENTS_RECEIVED>
+  <EMAILS_SENT>1</EMAILS_SENT>
+  <NUMBER_ERRORS>0</NUMBER_ERRORS>
+  <STATUS>0</STATUS>
+  <ERROR_CODE></ERROR_CODE>
+  <ERROR_STRING></ERROR_STRING>
+</XTMAILING_RESPONSE>
+```
+
+When something is wrong:
+
+```
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<XTMAILING_RESPONSE>
+  <CAMPAIGN_ID>1807752</CAMPAIGN_ID>
+  <RECIPIENTS_RECEIVED>1</RECIPIENTS_RECEIVED>
+  <EMAILS_SENT>0</EMAILS_SENT>
+  <NUMBER_ERRORS>1</NUMBER_ERRORS>
+  <STATUS>2</STATUS>
+  <ERROR_CODE>2</ERROR_CODE>
+  <ERROR_STRING>something wrong!</ERROR_STRING>
+</XTMAILING_RESPONSE>
+```
+
+```
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<XTMAILING_RESPONSE>
+  <CAMPAIGN_ID>4914098</CAMPAIGN_ID>
+  <RECIPIENTS_RECEIVED>1</RECIPIENTS_RECEIVED>
+  <EMAILS_SENT>0</EMAILS_SENT>
+  <NUMBER_ERRORS>1</NUMBER_ERRORS>
+  <STATUS>2</STATUS>
+  <ERROR_CODE>0</ERROR_CODE>
+  <ERROR_STRING></ERROR_STRING>
+  <RECIPIENT_DETAIL>
+    <EMAIL>user_email</EMAIL>
+    <SEND_STATUS>1</SEND_STATUS>
+    <ERROR_CODE>4</ERROR_CODE>
+    <ERROR_STRING>invalid email address user_email</ERROR_STRING>
+  </RECIPIENT_DETAIL>
+</XTMAILING_RESPONSE>
+```

data/lib/planet_express/configuration.rb

@@ -0,0 +1,9 @@
+module PlanetExpress
+  class Configuration
+    attr_accessor :gateway_url
+
+    def initialize *args
+      @gateway_url = 'https://transact5.silverpop.com/XTMail'
+    end
+  end
+end

data/lib/planet_express/delivery.rb

@@ -1,27 +1,40 @@
 module PlanetExpress
   class Delivery
-    # Everybody needs log in your life
-    cattr_accessor :logger
-    self.logger = Logger.new(STDOUT)
-
-    def prepare campaign_id, recipient, personalizations={}
-      # Is a better way to do this?
-      @campaign_id      = campaign_id
-      @recipient        = recipient
-      @personalizations = personalizations
+    include Log4r
+
+    attr_accessor :configuration
+    attr_accessor :logger
+
+    def initialize *args
+      # Settings
+      self.configuration ||= PlanetExpress::Configuration.new
+
+      # By default try to use the same logger than Rails
+      begin
+        self.logger = Rails.logger
+      rescue
+        self.logger = Log4r::Logger.new('PlanetExpress')
+        self.logger.outputters << Log4r::Outputter.stdout
+      end
 
-      logger.info "::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"
-      logger.info "campaign_id      => #{@campaign_id}"
-      logger.info "recipient        => #{@recipient}"
-      logger.info "personalizations => #{@personalizations}"
-      logger.info "personalizations total => #{@personalizations.count}"
+      logger.info "gateway_url => #{configuration.gateway_url}"
+    end
+
+    def configure
+      # Override Settings
+      yield(configuration)
+    end
 
+    def prepare campaign_id, recipient, personalizations={}
+      @campaign_id, @recipient, @personalizations = campaign_id, recipient, personalizations
       @personalizations.merge!({ :timestamp => Time.now, :email_template => @campaign_id })
+      raise PlanetExpress::ArgumentError if campaign_id.nil? or recipient.nil?
+
       build_request
     end
 
     def deliver!
-      url = URI.parse 'https://transact5.silverpop.com/XTMail'
+      url = URI.parse configuration.gateway_url
       http, resp    = Net::HTTP.new(url.host, url.port), ''
       http.use_ssl  = true
 
@@ -40,40 +53,37 @@ module PlanetExpress
 
       @personalizations.each_pair do |name, value|
         fields_xml +=
-        "<PERSONALIZATION>" +
-        "  <TAG_NAME>#{name}</TAG_NAME>" +
-        "  <VALUE><![CDATA[#{value}]]></VALUE>" +
-        "</PERSONALIZATION>"
+        "    <PERSONALIZATION>\n" +
+        "      <TAG_NAME>#{name}</TAG_NAME>\n" +
+        "      <VALUE><![CDATA[#{value}]]></VALUE>\n" +
+        "    </PERSONALIZATION>\n"
       end
 
       recipient_xml =
-        "<RECIPIENT>" +
-        "  <EMAIL>" + @recipient + "</EMAIL>" +
-        "  <BODY_TYPE>HTML</BODY_TYPE>" +
-        "  #{fields_xml}" +
-        "</RECIPIENT>"
+        "  <RECIPIENT>\n" +
+        "    <EMAIL>" + @recipient + "</EMAIL>\n" +
+        "    <BODY_TYPE>HTML</BODY_TYPE>\n" +
+        "#{fields_xml}" +
+        "  </RECIPIENT>\n"
 
       @request =
-        "<?xml version='1.0' encoding='UTF-8' standalone='yes'?>" +
-        "<XTMAILING>" +
-        "  <CAMPAIGN_ID>#{@campaign_id}</CAMPAIGN_ID>" +
-        "  <SHOW_ALL_SEND_DETAIL>true</SHOW_ALL_SEND_DETAIL>" +
-        "  <SEND_AS_BATCH>false</SEND_AS_BATCH>" +
-        "  <NO_RETRY_ON_FAILURE>false</NO_RETRY_ON_FAILURE>" +
-        # "  <TRANSACTION_ID>" + @transaction_id + "</TRANSACTION_ID>" +
-        "  #{recipient_xml}" +
-        "</XTMAILING>"
-
-      logger.info "::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"
-      logger.info "request => #{@request}"
+        "<?xml version='1.0' encoding='UTF-8' standalone='yes'?>\n" +
+        "<XTMAILING>\n" +
+        "  <CAMPAIGN_ID>#{@campaign_id}</CAMPAIGN_ID>\n" +
+        "  <SHOW_ALL_SEND_DETAIL>true</SHOW_ALL_SEND_DETAIL>\n" +
+        "  <SEND_AS_BATCH>false</SEND_AS_BATCH>\n" +
+        "  <NO_RETRY_ON_FAILURE>false</NO_RETRY_ON_FAILURE>\n" +
+        # "  <TRANSACTION_ID>" + @transaction_id + "</TRANSACTION_ID>\n" +
+        "#{recipient_xml}" +
+        "</XTMAILING>\n"
 
+      logger.info "original request => \n#{@request}"
       @request
     end
 
     def build_response response
+      logger.info "original response => \n#{response}"
       @response = Hpricot::XML(response)
-      logger.info "::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"
-      logger.info "response => #{response.inspect}"
 
       status              = @response.at('STATUS').innerHTML.to_i
       error_string        = @response.at('ERROR_STRING').innerHTML

data/lib/planet_express/exceptions.rb

@@ -0,0 +1,8 @@
+module PlanetExpress
+  class Error < StandardError; end
+  class ArgumentError < ArgumentError;
+    def message
+      "Missing data. Please provide the campaign_id, recipient email and the personalizations hash."
+    end
+  end
+end

data/lib/planet_express/version.rb

@@ -1,3 +1,3 @@
 module PlanetExpress
-  VERSION = "0.0.3"
+  VERSION = "0.0.7"
 end

data/lib/planet_express.rb

@@ -1,9 +1,12 @@
+require 'hpricot'
+require 'log4r'
 require 'net/http'
 require 'uri'
-require 'hpricot'
 
-require "planet_express/version"
+require "planet_express/configuration"
 require "planet_express/delivery"
+require "planet_express/exceptions"
+require "planet_express/version"
 
 module PlanetExpress
 end

data/planet_express.gemspec

@@ -19,9 +19,12 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'activesupport'
   gem.add_dependency 'hpricot'
+  gem.add_dependency 'log4r'
 
+  gem.add_development_dependency 'awesome_print'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-bundler'
   gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planet_express
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +123,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -119,15 +167,19 @@ files:
 - .gitignore
 - .rbenv-version
 - .rvmrc
-- DEVELOP.md
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/contribute.md
+- doc/silverpop_api.md
 - lib/planet_express.rb
+- lib/planet_express/configuration.rb
 - lib/planet_express/delivery.rb
+- lib/planet_express/exceptions.rb
 - lib/planet_express/version.rb
 - planet_express.gemspec
 - spec/planet_express_spec.rb
@@ -144,18 +196,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4224548502706184700
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4224548502706184700
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23