correios-sro-xml 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5304bbd81d83f760e5828196f54a4e7bbb5e2fd5
-  data.tar.gz: 0492be9b896f68b266b72c979b80ed6dff68d238
+  metadata.gz: 33ba03e4d4da8858a2d3ba57add938e5257dd87d
+  data.tar.gz: b213f940b135bbf21283c4564decbd0ef0ad9b4e
 SHA512:
-  metadata.gz: 23cc2288024f0dd02ef64425c55b0cfcf5f0902f3befdc1b5662cb1c90e903b2c29b2d6391dfe62659d46d239db9b37138e5d90497f106f05b0ac11991712ac4
-  data.tar.gz: 1ffc569c2d430c092d616534a070584a71b7beb0256f049cd8a31288374286612f2524472706a32e95729c13ff91419d5d68f2600013dd7b18e87132efa839e8
+  metadata.gz: e093e621eb02f17f8e491d4471e2e28d272f91b19302316c8579d0048ecd1e594c62f925e71a00ecef5b17ac56af666eefa14902ab1491121e9aaabf9460f9bb
+  data.tar.gz: ff206b65aaef71d71825f66612d2230bfa9e5a56bd5ea48d81ff8587376ee93ff179d3ad824020861ee4ef83fb11bb3357cac4bf88de990b0eff9eb0325875fe

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: bundle exec rspec

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== Version 0.2.1
+- New: User and password can be set on configuration.
+
 == Version 0.2.0
 - Warning: Minimal required Ruby version from now is 1.9.3.
 - Improvement: Update LogMe gem to version 0.0.6 with support to log request and response messages.

data/README.rdoc

@@ -4,6 +4,12 @@ Tracking Objects System from Correios - SRO (Sistema de Rastreamento de Objetos
 
 http://prodis.net.br/images/ruby/2011/correios_logo.png
 
+{<img src="https://badge.fury.io/rb/correios-sro-xml.png" alt="Gem Version" />}[http://badge.fury.io/rb/correios-sro-xml]
+{<img src="https://travis-ci.org/prodis/correios-sro-xml.png?branch=master" alt="Build Status" />}[https://travis-ci.org/prodis/correios-sro-xml]
+{<img src="https://coveralls.io/repos/prodis/correios-sro-xml/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/prodis/correios-sro-xml]
+{<img src="https://codeclimate.com/github/prodis/correios-sro-xml.png" alt="Code Climate" />}[https://codeclimate.com/github/prodis/correios-sro-xml]
+{<img src="https://gemnasium.com/prodis/correios-sro-xml.png" alt="Dependency Status" />}[https://gemnasium.com/prodis/correios-sro-xml]
+
 In order to use SRO XML in production environment, it is necessary to request to Correios access data (user and password) for your company, as described in {Correios' Blog}[http://blog.correios.com.br/comercioeletronico/?p=218].
 
 For development environment you can use follow access data:
@@ -81,13 +87,22 @@ In which you supplie the first and last objects numbers of an interval.
   objects = sro.get("PB996681660BR", "PB996681700BR")
   objects.keys # => ["PB996681660BR", "PB996681673BR", "PB996681687BR", "PB996681695BR", "PB996681700BR"]
 
+
 == Configurations
 
+Use <b>Correios::SRO</b> module to set all available gem configuration.
+
+=== Access data
+
+You can supply SRO XML Web Service user and password in configuration instead of each instance of <b>Correios::SRO::Tracker</b> class.
+  Correios::SRO.configure do |config|
+    config.user = "ECT"
+    config.password = "SRO"
+  end
+
 === Timeout
 
 For default, the timeout for a request to SRO XML Web Service is <b>5 seconds</b>. If SRO XML Web Service does not respond, a <b>Timeout::Error</b> exception will be raised.
-You can configure this timeout using <b>Correios::SRO</b> module.
-
   Correios::SRO.configure do |config|
     config.request_timeout = 3 # It configures timeout to 3 seconds
   end
@@ -129,8 +144,7 @@ Log example:
        </objeto>
   </sroxml>
 
-To disable the log and configure other log output, use <b>Correios::SRO</b> module:
-
+You can disable the log and configure other log output.
   Correios::SRO.configure do |config|
     config.log_enabled = false   # It disables the log
     config.logger = Rails.logger # It uses Rails logger
@@ -139,6 +153,8 @@ To disable the log and configure other log output, use <b>Correios::SRO</b> modu
 === Configuration example
 
   Correios::SRO.configure do |config|
+    config.user = "ECT"
+    config.password = "SRO"
     config.logger = Rails.logger
     config.request_timeout = 3
   end

data/lib/correios-sro-xml.rb

@@ -1,3 +1,4 @@
+require 'correios/sro/access_data'
 require 'correios/sro/timeout'
 require 'correios/sro'
 require 'correios/sro/destination'

data/lib/correios/sro.rb

@@ -3,6 +3,7 @@ require 'log-me'
 module Correios
   module SRO
     extend LogMe
+    extend Correios::SRO::AccessData
     extend Correios::SRO::Timeout
   end
 end

data/lib/correios/sro/access_data.rb

@@ -0,0 +1,7 @@
+module Correios
+  module SRO
+    module AccessData
+      attr_accessor :user, :password
+    end
+  end
+end

data/lib/correios/sro/tracker.rb

@@ -14,6 +14,8 @@ module Correios
 
         yield self if block_given?
         @object_numbers = []
+
+        set_attributes_from_config!
       end
 
       def get(*object_numbers)
@@ -30,6 +32,12 @@ module Correios
 
       private
 
+      def set_attributes_from_config!
+        [:user, :password].each do |attr|
+          self.send("#{attr}=", Correios::SRO.send(attr)) unless self.send(attr)
+        end
+      end
+
       def web_service
         @web_service ||= Correios::SRO::WebService.new(self)
       end

data/lib/correios/sro/version.rb

@@ -1,5 +1,5 @@
 module Correios
   module SRO
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/spec/correios/sro/tracker_spec.rb

@@ -8,6 +8,27 @@ describe Correios::SRO::Tracker do
       expect(subject.object_numbers).to eql []
     end
 
+    context "when access data is supplied on configuration" do
+      around do |example|
+        Correios::SRO.configure do |config|
+          config.user = "SROUSER"
+          config.password = "1q2w3e"
+        end
+
+        example.run
+
+        Correios::SRO.configure do |config|
+          config.user = nil
+          config.password = nil
+        end
+      end
+
+      it "uses access data from configuration" do
+        expect(subject.user).to eql "SROUSER"
+        expect(subject.password).to eql "1q2w3e"
+      end
+    end
+
     { user: "PRODIS",
       password: "pim321",
       query_type: :range,

data/spec/correios/sro_spec.rb

@@ -1,20 +1,38 @@
 require 'spec_helper'
 
 describe Correios::SRO do
-  describe "#request_timeout" do
-    it "default is 5" do
-      Correios::SRO.request_timeout.should eql 5
+  context "timeout" do
+    describe "#request_timeout" do
+      it "default is 5" do
+        expect(Correios::SRO.request_timeout).to eql 5
+      end
+
+      context "when set timeout" do
+        it "returns timeout" do
+          Correios::SRO.configure { |config| config.request_timeout = 3 }
+          expect(Correios::SRO.request_timeout).to eql 3
+        end
+
+        it "returns timeout in seconds (integer)" do
+          Correios::SRO.configure { |config| config.request_timeout = 2.123 }
+          expect(Correios::SRO.request_timeout).to eql 2
+        end
+      end
     end
+  end
 
-    context "when set timeout" do
-      it "returns timeout" do
-        Correios::SRO.configure { |config| config.request_timeout = 3 }
-        Correios::SRO.request_timeout.should eql 3
+  context "access data" do
+    describe "#user" do
+      it "returns configured user" do
+        Correios::SRO.configure { |config| config.user = "PRODIS" }
+        expect(Correios::SRO.user).to eql "PRODIS"
       end
+    end
 
-      it "returns timeout in seconds (integer)" do
-        Correios::SRO.configure { |config| config.request_timeout = 2.123 }
-        Correios::SRO.request_timeout.should eql 2
+    describe "#password" do
+      it "returns configured password" do
+        Correios::SRO.configure { |config| config.password = "pim321" }
+        expect(Correios::SRO.password).to eql "pim321"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: correios-sro-xml
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Prodis a.k.a. Fernando Hamasaki de Amorim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log-me
@@ -147,6 +147,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.rdoc
 - Gemfile
 - README.rdoc
@@ -154,6 +155,7 @@ files:
 - correios-sro-xml.gemspec
 - lib/correios-sro-xml.rb
 - lib/correios/sro.rb
+- lib/correios/sro/access_data.rb
 - lib/correios/sro/destination.rb
 - lib/correios/sro/event.rb
 - lib/correios/sro/object.rb