oca-epak 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c5f04a073183bc57a5503b8a5c677a01e45aa21
-  data.tar.gz: a24c7b70efa907c1b263caf863e2b7cd3e285a9e
+  metadata.gz: eeede2d0da740bfb15092074d0d39c538874d439
+  data.tar.gz: 8e3a86749633428e59c54752f7cc7063758f0171
 SHA512:
-  metadata.gz: 19683eaa6a9815526daffbd659240d5e99cd0e55b15a8d657d46f97f7e25b8ba33741468173bc5c058aaad78a397847bd9050f0ee4c645fb57f035865b6c3a43
-  data.tar.gz: c9257ce2e186a08c5ffe1e67004f73504113c56007a27ffedc6d81be57cf005b38105dfa83d82baf8e958b587c2bcb53bee576eb7607a3adfd9b6591cf5e31fb
+  metadata.gz: 425848307e4ac16a2fdfaf92578ad2b7f687c038262bb9756a4c3db5655e79fc69df0d98b24bef88c87ba755689e45aec03e7d900c2e1d04ae610c3fba85f73d
+  data.tar.gz: c042b2dd09704baf5853924121ececcc4d01cda14375cb009a57eb677d838337a94cbf487880ba21caa4fea3c624a4326dfe27a2c52b7c9828a4f52a61ca886e

data/lib/oca-epak.rb

@@ -1,160 +1,7 @@
 require 'savon'
 require 'erb'
 require 'ostruct'
+require 'oca-epak/client'
 require 'oca-epak/pickup_data'
-require 'oca-epak/errors/error'
+require 'oca-epak/errors/generic_error'
 require 'oca-epak/errors/bad_request'
-
-module Oca
-  class Epak
-    attr_reader :client
-    attr_accessor :username, :password
-
-    WSDL = 'http://webservice.oca.com.ar/epak_tracking/Oep_TrackEPak.asmx?wsdl'.freeze
-
-    def initialize(username, password)
-      @client = Savon.client(wsdl: WSDL)
-      @username = username
-      @password = password
-    end
-
-    # Checks if the user has input valid credentials
-    #
-    # @return [Boolean] Whether the credentials entered are valid or not
-    def check_credentials
-      method = :get_epack_user
-      opts = { "usr" => username, "psw" => password }
-      response = client.call(method, message: opts)
-      parse_results_table(response, method)[:existe] == "1"
-    end
-
-    # Checks whether the operation is valid
-    #
-    # @param [String] Client's CUIT
-    # @param [String] Operation Type
-    # @return [Boolean]
-    def check_operation(cuit, op)
-      begin
-        opts = { wt: "50", vol: "0.027", origin: "1414", destination: "5403",
-                 qty: "1", total: "123", cuit: cuit, op: op }
-        get_shipping_rates(opts)
-        true
-      rescue Oca::Epak::Error => e
-        false
-      end
-    end
-
-    # Creates a Pickup Order, which lets OCA know you want to make a delivery.
-    #
-    # @see [http://www.ombushop.com/oca/documentation.pdf] #TODO put it there
-    #
-    # @param [Hash] opts
-    # @option [Oca::Epak::PickupData] :pickup_data Pickup Data object
-    # @option [Boolean] :confirm_pickup Confirm Pickup? Defaults to false
-    # @option [Integer] :days_to_pickup Days OCA should wait before pickup, default: 1 (?) #TODO Confirm
-    # @option [Integer] :pickup_range Range to be used when picking it up, default: 1
-    # @return [Hash, nil]
-    def create_pickup_order(opts = {})
-      confirm_pickup = opts.fetch(:confirm_pickup, false)
-      days_to_pickup = opts.fetch(:days_to_pickup, "1")
-      pickup_range = opts.fetch(:pickup_range, "1")
-      rendered_xml = opts[:pickup_data].to_xml
-
-      message = { "usr" => username, "psw" => password,
-                  "xml_Datos" => rendered_xml,
-                  "ConfirmarRetiro" => confirm_pickup.to_s,
-                  "DiasHastaRetiro" => days_to_pickup,
-                  "idFranjaHoraria" => pickup_range }
-      response = client.call(:ingreso_or, message: message)
-      parse_results_table(response, :ingreso_or)
-    end
-
-    # Get rates and delivery estimate for a shipment
-    #
-    # @param [Hash] opts
-    # @option [String] :wt Total Weight e.g: 20
-    # @option [String] :vol Total Volume e.g: 0.0015 (0.1mts * 0.15mts * 0.1mts)
-    # @option [Integer] :origin Origin ZIP Code
-    # @option [Integer] :destination Destination ZIP Code
-    # @option [Integer] :qty Quantity of Packages
-    # @option [Integer] :total Declared Value
-    # @option [String] :cuit Client's CUIT e.g: 30-99999999-7
-    # @option [String] :op Operation Type
-    # @return [Hash, nil] Contains Total Price, Delivery Estimate
-    def get_shipping_rates(opts = {})
-      method = :tarifar_envio_corporativo
-      message = { "PesoTotal" => opts[:wt], "VolumenTotal" => opts[:vol],
-                  "CodigoPostalOrigen" => opts[:origin],
-                  "CodigoPostalDestino" => opts[:destination],
-                  "ValorDeclarado" => opts[:total],
-                  "CantidadPaquetes" => opts[:qty], "Cuit" => opts[:cuit],
-                  "Operativa" => opts[:op] }
-      response = client.call(method, message: message)
-      parse_results_table(response, method)
-    end
-
-    # Returns all existing Taxation Centers
-    #
-    # @return [Array, nil] Information for all the Oca Taxation Centers
-    def taxation_centers
-      method = :get_centros_imposicion
-      response = client.call(method)
-      parse_results_table(response, method)
-    end
-
-    # Returns all operation codes
-    #
-    # @return [Array, nil] Returns all operation codes available for the user
-    def get_operation_codes
-      method = :get_operativas_by_usuario
-      opts = { "usr" => username, "psw" => password }
-      response = client.call(method, message: opts)
-      parse_results_table(response, method)
-    end
-
-    # Given a client's CUIT with a range of dates, returns a list with
-    # all shipments made within the given period.
-    #
-    # @param [String] Client's CUIT
-    # @param [String] "From date" in DD-MM-YYYY format
-    # @param [String] "To date" in DD-MM-YYYY format
-    # @return [Array, nil] Contains an array of hashes with NroProducto and NumeroEnvio
-    def list_shipments(cuit, from_date, to_date)
-      method = :list_envios
-      opts = { "CUIT" => cuit, "FechaDesde" => from_date,
-               "FechaHasta" => to_date }
-      response = client.call(method, message: opts)
-      parse_results_table(response, method)
-    end
-
-    # Returns all provinces in Argentina
-    #
-    # @return [Array, nil] Provinces in Argentina with their ID and name as a Hash
-    def provinces
-      response = client.call(:get_provincias)
-      if body = response.body[:get_provincias_response]
-        body[:get_provincias_result][:provincias][:provincia]
-      end
-    end
-
-    private
-
-      def parse_result(response, method)
-        method_response = "#{method}_response".to_sym
-        method_result = "#{method}_result".to_sym
-        if body = response.body[method_response]
-          body[method_result]
-        end
-      end
-
-      def parse_results_table(response, method)
-        if result = parse_result(response, method)
-          if result[:diffgram][:new_data_set]
-            result[:diffgram][:new_data_set][:table]
-          else
-            raise Oca::Epak::BadRequest.new("Oca WS responded with:\n#{response.body}")
-          end
-        end
-      end
-  end
-end

data/lib/oca-epak/client.rb

@@ -0,0 +1,155 @@
+module Oca
+  module Epak
+    class Client
+      attr_reader :client
+      attr_accessor :username, :password
+
+      WSDL = 'http://webservice.oca.com.ar/epak_tracking/Oep_TrackEPak.asmx?wsdl'.freeze
+
+      def initialize(username, password)
+        @client = Savon.client(wsdl: WSDL)
+        @username = username
+        @password = password
+      end
+
+      # Checks if the user has input valid credentials
+      #
+      # @return [Boolean] Whether the credentials entered are valid or not
+      def check_credentials
+        method = :get_epack_user
+        opts = { "usr" => username, "psw" => password }
+        response = client.call(method, message: opts)
+        parse_results_table(response, method)[:existe] == "1"
+      end
+
+      # Checks whether the operation is valid
+      #
+      # @param [String] Client's CUIT
+      # @param [String] Operation Type
+      # @return [Boolean]
+      def check_operation(cuit, op)
+        begin
+          opts = { wt: "50", vol: "0.027", origin: "1414", destination: "5403",
+                   qty: "1", total: "123", cuit: cuit, op: op }
+          get_shipping_rates(opts)
+          true
+        rescue Oca::Epak::GenericError => e
+          false
+        end
+      end
+
+      # Creates a Pickup Order, which lets OCA know you want to make a delivery.
+      #
+      # @see [http://www.ombushop.com/oca/documentation.pdf] #TODO put it there
+      #
+      # @param [Hash] opts
+      # @option [Oca::Epak::PickupData] :pickup_data Pickup Data object
+      # @option [Boolean] :confirm_pickup Confirm Pickup? Defaults to false
+      # @option [Integer] :days_to_pickup Days OCA should wait before pickup, default: 1 (?) #TODO Confirm
+      # @option [Integer] :pickup_range Range to be used when picking it up, default: 1
+      # @return [Hash, nil]
+      def create_pickup_order(opts = {})
+        confirm_pickup = opts.fetch(:confirm_pickup, false)
+        days_to_pickup = opts.fetch(:days_to_pickup, "1")
+        pickup_range = opts.fetch(:pickup_range, "1")
+        rendered_xml = opts[:pickup_data].to_xml
+
+        message = { "usr" => username, "psw" => password,
+                    "xml_Datos" => rendered_xml,
+                    "ConfirmarRetiro" => confirm_pickup.to_s,
+                    "DiasHastaRetiro" => days_to_pickup,
+                    "idFranjaHoraria" => pickup_range }
+        response = client.call(:ingreso_or, message: message)
+        parse_results_table(response, :ingreso_or)
+      end
+
+      # Get rates and delivery estimate for a shipment
+      #
+      # @param [Hash] opts
+      # @option [String] :wt Total Weight e.g: 20
+      # @option [String] :vol Total Volume e.g: 0.0015 (0.1mts * 0.15mts * 0.1mts)
+      # @option [Integer] :origin Origin ZIP Code
+      # @option [Integer] :destination Destination ZIP Code
+      # @option [Integer] :qty Quantity of Packages
+      # @option [Integer] :total Declared Value
+      # @option [String] :cuit Client's CUIT e.g: 30-99999999-7
+      # @option [String] :op Operation Type
+      # @return [Hash, nil] Contains Total Price, Delivery Estimate
+      def get_shipping_rates(opts = {})
+        method = :tarifar_envio_corporativo
+        message = { "PesoTotal" => opts[:wt], "VolumenTotal" => opts[:vol],
+                    "CodigoPostalOrigen" => opts[:origin],
+                    "CodigoPostalDestino" => opts[:destination],
+                    "ValorDeclarado" => opts[:total],
+                    "CantidadPaquetes" => opts[:qty], "Cuit" => opts[:cuit],
+                    "Operativa" => opts[:op] }
+        response = client.call(method, message: message)
+        parse_results_table(response, method)
+      end
+
+      # Returns all existing Taxation Centers
+      #
+      # @return [Array, nil] Information for all the Oca Taxation Centers
+      def taxation_centers
+        method = :get_centros_imposicion
+        response = client.call(method)
+        parse_results_table(response, method)
+      end
+
+      # Returns all operation codes
+      #
+      # @return [Array, nil] Returns all operation codes available for the user
+      def get_operation_codes
+        method = :get_operativas_by_usuario
+        opts = { "usr" => username, "psw" => password }
+        response = client.call(method, message: opts)
+        parse_results_table(response, method)
+      end
+
+      # Given a client's CUIT with a range of dates, returns a list with
+      # all shipments made within the given period.
+      #
+      # @param [String] Client's CUIT
+      # @param [String] "From date" in DD-MM-YYYY format
+      # @param [String] "To date" in DD-MM-YYYY format
+      # @return [Array, nil] Contains an array of hashes with NroProducto and NumeroEnvio
+      def list_shipments(cuit, from_date, to_date)
+        method = :list_envios
+        opts = { "CUIT" => cuit, "FechaDesde" => from_date,
+                 "FechaHasta" => to_date }
+        response = client.call(method, message: opts)
+        parse_results_table(response, method)
+      end
+
+      # Returns all provinces in Argentina
+      #
+      # @return [Array, nil] Provinces in Argentina with their ID and name as a Hash
+      def provinces
+        response = client.call(:get_provincias)
+        if body = response.body[:get_provincias_response]
+          body[:get_provincias_result][:provincias][:provincia]
+        end
+      end
+
+      private
+
+        def parse_result(response, method)
+          method_response = "#{method}_response".to_sym
+          method_result = "#{method}_result".to_sym
+          if body = response.body[method_response]
+            body[method_result]
+          end
+        end
+
+        def parse_results_table(response, method)
+          if result = parse_result(response, method)
+            if result[:diffgram][:new_data_set]
+              result[:diffgram][:new_data_set][:table]
+            else
+              raise Oca::Epak::BadRequest.new("Oca WS responded with:\n#{response.body}")
+            end
+          end
+        end
+    end
+  end
+end

data/lib/oca-epak/errors/bad_request.rb

@@ -1,4 +1,6 @@
 module Oca
-  class Epak::BadRequest < Epak::Error
+  module Epak
+    class BadRequest < GenericError
+    end
   end
 end

data/lib/oca-epak/errors/generic_error.rb

@@ -0,0 +1,6 @@
+module Oca
+  module Epak
+    class GenericError < StandardError
+    end
+  end
+end

data/lib/oca-epak/pickup_data.rb

@@ -1,29 +1,30 @@
 module Oca
-  class Epak::PickupData
+  module Epak
+    class PickupData
+      attr_accessor :account_number, :pickup, :shipments
 
-    attr_accessor :account_number, :pickup, :shipments
-
-    # Creates a Pickup Data object for creating a pickup order in OCA.
-    #
-    # @param [Hash] opts
-    # @option [String] :account_number Account Number (SAP)
-    # @option [Hash] :pickup Pickup Hash
-    # @option [Array<Hash>] :shipments Shipments Hash
-    def initialize(opts = {})
-      self.account_number = opts[:account_number]
-      self.pickup = opts[:pickup]
-      self.shipments = opts[:shipments]
-    end
+      # Creates a Pickup Data object for creating a pickup order in OCA.
+      #
+      # @param [Hash] opts
+      # @option [String] :account_number Account Number (SAP)
+      # @option [Hash] :pickup Pickup Hash
+      # @option [Array<Hash>] :shipments Shipments Hash
+      def initialize(opts = {})
+        self.account_number = opts[:account_number]
+        self.pickup = opts[:pickup]
+        self.shipments = opts[:shipments]
+      end
 
-    def to_xml
-      or_template.result(binding)
-    end
+      def to_xml
+        or_template.result(binding)
+      end
 
-    private
+      private
 
-      def or_template
-        path_to_xml = File.expand_path("../retiro.xml.erb", __FILE__)
-        ERB.new(File.read(path_to_xml), nil, "-")
-      end
+        def or_template
+          path_to_xml = File.expand_path("../retiro.xml.erb", __FILE__)
+          ERB.new(File.read(path_to_xml), nil, "-")
+        end
+    end
   end
 end

data/lib/oca-epak/version.rb

@@ -1,5 +1,5 @@
 module Oca
-  class Epak
-    VERSION = '1.0.0'
+  module Epak
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oca-epak
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mauro Otonelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -104,8 +104,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/oca-epak.rb
+- lib/oca-epak/client.rb
 - lib/oca-epak/errors/bad_request.rb
-- lib/oca-epak/errors/error.rb
+- lib/oca-epak/errors/generic_error.rb
 - lib/oca-epak/pickup_data.rb
 - lib/oca-epak/version.rb
 homepage: https://github.com/ombulabs/oca-epak

data/lib/oca-epak/errors/error.rb

@@ -1,4 +0,0 @@
-module Oca
-  class Epak::Error < StandardError
-  end
-end