click_and_send 0.0.4 → 0.0.5

data/.gitignore

@@ -9,6 +9,7 @@ _yardoc
 coverage
 doc/
 lib/bundler/man
+log/*.log
 pkg
 rdoc
 spec/fixtures/config.yml

data/README.md

@@ -1,10 +1,12 @@
-# ClickAndSend
+ClickAndSend
+============
 
 Ruby adapter for Australia Post's [ClickAndSend](http://www.clickandsend.com.au/) API.
 
 [![Build Status](https://secure.travis-ci.org/zubin/click_and_send.png)](http://travis-ci.org/zubin/click_and_send)
 
-## Installation
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
@@ -18,7 +20,8 @@ Or install it yourself as:
 
     $ gem install click_and_send
 
-## Usage
+Usage
+-----
 
 Configure like this:
 
@@ -32,15 +35,30 @@ Configure like this:
 Note that the WSDL URL above is for ClickAndSend's staging environment.
 
 You should only need to call methods on the `ClickAndSend` class.
-Refer to the docs and acceptance tests for usage examples.
+Refer to ClickAndSend docs and acceptance tests for usage examples.
 
-## Gotchas
+Optionally configure a logger. It defaults to a standard Logger instance writing to log/click\_and\_send.log or
+Rails.logger when applicable.
+
+    # Set logfile
+    ClickAndSend.configure do |c|
+      c.logfile = 'path/to/my/logfile'
+    end
+
+    # Custom logger
+    ClickAndSend.configure do |c|
+      c.logger = MyApp.logger
+    end
+
+Gotchas
+-------
 
 Order is important for ClickAndSend API data structures. Therefore, under ruby 1.8, use
 [`ActiveSupport::OrderedHash`](http://rdoc.info/gems/activesupport/ActiveSupport/OrderedHash.html) instead of a regular
 hash.
 
-## Contributing
+Contributing
+------------
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/click_and_send.rb

@@ -58,7 +58,7 @@ module ClickAndSend
 
     def find_tracking_numbers(refs)
       item_summary.inject({}) do |hash,item|
-        if refs.include?(item[:cust_transaction_id])
+        if item.kind_of?(Hash) && refs.include?(item[:cust_transaction_id])
           hash[item[:cust_transaction_id]] ||= []
           hash[item[:cust_transaction_id]] << item[:tracking_number]
         end
@@ -70,8 +70,18 @@ module ClickAndSend
       Request::ItemSummary.new.result.fetch(:item_summary_transaction)
     end
 
+    def logger
+      @logger ||= begin
+        configuration.logger or if rails? && !configured_logfile
+          Rails.logger
+        else
+          Logger.new(logfile)
+        end
+      end
+    end
+
     def pdf_url(ref)
-      tracking_numbers = find_tracking_numbers([ref]).fetch(ref)
+      tracking_numbers = find_tracking_numbers([ref])[ref] || {}
       case tracking_numbers.length
       when 0 then raise(Errors::APIError, "Not found: '#{ref}'")
       when 1 then tracking_number = tracking_numbers.first
@@ -87,11 +97,27 @@ module ClickAndSend
 
     private
 
+    def configured_logfile
+      ClickAndSend.configuration.logfile
+    end
+
     def ensure_keys_present(hash, required_keys)
       missing_keys = required_keys - hash.keys
       if missing_keys.any?
         raise(Errors::InvalidInput, "Missing: #{missing_keys.join(', ')}")
       end
     end
+
+    def gem_root
+      File.expand_path('..', File.dirname(__FILE__))
+    end
+
+    def logfile
+      configured_logfile || File.join(gem_root, 'log/click_and_send.log')
+    end
+
+    def rails?
+      defined?(Rails)
+    end
   end
 end

data/lib/click_and_send/configuration.rb

@@ -1,6 +1,6 @@
 module ClickAndSend
   class Configuration
-    ATTRIBUTES = [:account_number, :api_version, :api_key, :user_name, :wsdl]
+    ATTRIBUTES = [:account_number, :api_version, :api_key, :logfile, :logger, :user_name, :wsdl]
     attr_accessor *ATTRIBUTES
 
     def initialize
@@ -8,11 +8,19 @@ module ClickAndSend
     end
 
     def errors
-      Hash[ATTRIBUTES.collect { |attribute| [attribute, ("is required" if send(attribute).nil?)] }]
+      Hash[(ATTRIBUTES - optional_attributes).collect do |attribute|
+        [attribute, ("is required" if send(attribute).nil?)]
+      end]
     end
 
     def valid?
       errors.values.compact.empty?
     end
+
+    private
+
+    def optional_attributes
+      [:logfile, :logger]
+    end
   end
 end

data/lib/click_and_send/request.rb

@@ -90,7 +90,14 @@ module ClickAndSend
     end
 
     def response
-      @response ||= Nori.parse(request.to_hash[key(:response)][key(:response)]).fetch(key(:answer))
+      @response ||= begin
+        raw = request.to_hash[key(:response)][key(:response)]
+        result = Nori.parse(raw)
+        result.fetch(key(:answer))
+      rescue IndexError => e
+        # binding.pry
+        raise
+      end
     end
 
     def request

data/lib/click_and_send/version.rb

@@ -1,3 +1,3 @@
 module ClickAndSend
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/acceptance_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe ClickAndSend, :acceptance do
-  let(:item_details) {  }
   before { load_config(:acceptance) }
+  after(:all) { cleanup }
 
   describe '.check_services' do
     subject { ClickAndSend.check_services(attributes_for(%w(Sender Receiver ItemDetails))) }
@@ -67,6 +67,8 @@ describe ClickAndSend, :acceptance do
           ClickAndSend.delete_items('DeleteItems' => items)
         end.to change { ClickAndSend.find_tracking_numbers(ref).empty? }.to(true)
       end
+
+      it "deletes multiple items"
     end
   end
 

data/spec/click_and_send/xml_spec.rb

@@ -14,5 +14,22 @@ describe ClickAndSend::XML do
       let(:input) { {:a => {:b => 2}} }
       it { should == "<a><b>2</b></a>" }
     end
+
+    context "hash/array combo" do
+      let(:input) do
+        {'DeleteItems' => [
+          {'DeleteItem' => {'CustTransactionID' => 1, 'TrackingNumber' => 'A'}},
+          {'DeleteItem' => {'CustTransactionID' => 2, 'TrackingNumber' => 'B'}},
+        ]}
+      end
+      it "encapsulates hash value with key" do
+        pending "required for deleting multiple items (?) but not how gyoku generates xml"
+        expected_xml = '<DeleteItems>'+
+          '<DeleteItem><CustTransactionID>1</CustTransactionID><TrackingNumber>A</TrackingNumber></DeleteItem>'+
+          '<DeleteItem><CustTransactionID>2</CustTransactionID><TrackingNumber>B</TrackingNumber></DeleteItem>'+
+          '</DeleteItems>'
+        should eq(expected_xml)
+      end
+    end
   end
 end

data/spec/click_and_send_spec.rb

@@ -35,6 +35,45 @@ describe ClickAndSend do
     end
   end
 
+  describe '.logger' do
+    subject { ClickAndSend.logger }
+    let(:logfile) { File.join(root_path, 'log/click_and_send.log') }
+    before { ClickAndSend.configure {}; reset_logger }
+
+    it "defaults to Logger instance" do
+      subject.should be_a(Logger)
+    end
+
+    it "writes to logfile log/click_and_send.log" do
+      Logger.should_receive(:new).with(logfile)
+      subject
+    end
+
+    context "external logger configured" do
+      before { ClickAndSend.configure { |c| c.logger = other_logger } }
+      let(:other_logger) { stub(:other_logger) }
+
+      it "uses configured logger" do
+        subject.should eq(other_logger)
+      end
+    end
+
+    context "when Rails" do
+      before { Rails = stub(:logger => "rails_logger") }
+      it { should eq("rails_logger") }
+
+      context "when logfile set in configuration" do
+        before { ClickAndSend.configure { |c| c.logfile = configured_logfile } }
+        let(:configured_logfile) { File.join(root_path, 'log/click_and_send.configured.log') }
+
+        it "writes to configured logfile" do
+          Logger.should_receive(:new).with(configured_logfile)
+          subject
+        end
+      end
+    end
+  end
+
   context "requests" do
     describe '.check_services' do
       subject { ClickAndSend.check_services(options) }
@@ -79,7 +118,7 @@ describe ClickAndSend do
       let(:required_inputs) { %w(DeleteItems) }
       it_behaves_like "data required"
       it "calls DeleteItems result" do
-        ClickAndSend::Request::DeleteItems.should_receive(:new) { stub(:result => 'deleted') }
+        ClickAndSend::Request::DeleteItems.should_receive(:new).with(options) { stub(:result => 'deleted') }
         subject.should == 'deleted'
       end
     end
@@ -140,7 +179,7 @@ describe ClickAndSend do
       end
 
       context "no matching tracking numbers" do
-        let(:tracking_numbers) { [] }
+        before { ClickAndSend.stub(:find_tracking_numbers).with(['REF']) { {} } }
         it "raises API error" do
           expect { subject }.to raise_error(ClickAndSend::Errors::APIError, "Not found: 'REF'")
         end

data/spec/support/helpers.rb

@@ -3,12 +3,20 @@ require 'yaml'
 module ClickAndSend
   module Test
     module Helpers
+      def cleanup
+        puts "--> Cleaning up"
+        refs = ClickAndSend.item_summary.collect { |item| item[:cust_transaction_id] }
+        # TODO: Delete in one API call when delete multiple items implemented.
+        # ClickAndSend.delete_items_by_ref(refs) if refs.any?
+        refs.each { |ref| ClickAndSend.delete_items_by_ref(ref) }
+      end
+
       def load_config(mode = :test)
         yaml_config_path = case mode
         when :test
-          File.expand_path(File.join(File.dirname(__FILE__), '../fixtures/config.example.yml'))
+          File.join(root_path, 'spec/fixtures/config.example.yml')
         when :acceptance
-          File.expand_path(File.join(File.dirname(__FILE__), '../fixtures/config.yml'))
+          File.join(root_path, 'spec/fixtures/config.yml')
         end
         if File.exists?(yaml_config_path)
           ClickAndSend.configure do |config|
@@ -18,6 +26,14 @@ module ClickAndSend
           pending "Can't run acceptance tests because #{yaml_config_path} is missing. See fixtures/config.example.yml."
         end
       end
+
+      def reset_logger
+        ClickAndSend.instance_variable_set('@logger', nil)
+      end
+
+      def root_path
+        File.expand_path('../..', File.dirname(__FILE__))
+      end
     end
   end
 end

metadata

@@ -1,132 +1,135 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: click_and_send
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Zubin Henner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
-  requirement: *id001
   prerelease: false
-  name: activesupport
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  requirement: *id002
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
   name: nori
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: *id003
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: savon
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  requirement: *id004
+    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: rake
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id005
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id006
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: faker
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id007
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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'
 description: Ruby adapter for Australia Post's ClickAndSend API
-email: 
+email:
 - zubin.henner@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -147,6 +150,7 @@ files:
 - lib/click_and_send/request/print_item.rb
 - lib/click_and_send/version.rb
 - lib/click_and_send/xml.rb
+- log/.gitkeep
 - spec/acceptance_spec.rb
 - spec/click_and_send/request_spec.rb
 - spec/click_and_send/xml_spec.rb
@@ -159,38 +163,35 @@ files:
 - spec/support/shared_examples.rb
 homepage: https://github.com/zubin/click_and_send
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1313746178528198946
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -1313746178528198946
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby adapter for Australia Post's ClickAndSend API
-test_files: 
+test_files:
 - spec/acceptance_spec.rb
 - spec/click_and_send/request_spec.rb
 - spec/click_and_send/xml_spec.rb