fedex_rate_getter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9284bc1551b6536592a805000b5f612d5adf7e5f972b398e8b0054f79962333b
+  data.tar.gz: 6e2c632974b44ce6f1d0e777b9a925e8909b991e30723d52dc099993228bda15
+SHA512:
+  metadata.gz: c2ca178c499078e50c9da9adbc53de8ca9b084f1fdfc12b782c669b9073e406240dcc4e035c46ca81b7c187fae0a292f38d9ca83306f0777613df46b65bcb8e1
+  data.tar.gz: f4c6da665b9e1ee864e0bb9c734c8c70218b5e9ae43292f041f8195dba119049fb38d18f1d47dbaffd339d90625e778f21681ae2b06bc46b01b2e73f2e608651

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fedex_rate_getter.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'faraday', '~> 0.9.2'
+gem 'libxml-ruby', '~> 3.2.3'
+gem 'activesupport', '~> 5.0'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    fedex_rate_getter (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    libxml-ruby (3.2.3)
+    minitest (5.16.3)
+    multipart-post (2.2.3)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  activesupport (~> 5.0)
+  faraday (~> 0.9.2)
+  fedex_rate_getter!
+  libxml-ruby (~> 3.2.3)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fedex_rate_getter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fedex_rate_getter
+
+## Usage
+
+```ruby
+    require 'fedex_rate_getter'
+
+
+    FedexRateGetter::Rate.get(credentials, quote_params)
+```
+
+These are the correct structures for:
+
+```json
+
+    quote_params = {
+        address_from: {
+            zip: "64000",
+            country: "MX"
+        },
+        address_to: {
+            zip: "64000",
+            country: "MX"
+        },
+        parcel: {
+            length: 25,
+            width: 28,
+            height: 46.0,
+            distance_unit: "cm",
+            weight: 6.5,
+            mass_unit: "kg"
+        } 
+    }
+
+    credentials = {
+        user_credential: {
+            key: 'bkjdkeEWIgUhxdghtLw9L', # api key
+            password: '6p8oOccHmDwuJZCyJs44wQ0Iw' # api password
+        },
+        client_detail: {
+            account_number: '510087720', #fedex account number
+            metter_number: '119238439', #fedex metter number
+            language_code: 'es', # language [es, en, ...]
+            locale_code: 'mx' # Country code [mx, usa, ...]
+        }
+    }
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fedex_rate_getter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/fedex_rate_getter/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FedexRateGetter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fedex_rate_getter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fedex_rate_getter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fedex_rate_getter.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/fedex_rate_getter/version'
+require_relative "lib/fedex_rate_getter/version"
+require_relative "lib/fedex_rate_getter/connection"
+require_relative "lib/fedex_rate_getter/formatter/body"
+require_relative "lib/fedex_rate_getter/formatter/response"
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "fedex_rate_getter"
+  spec.version       = FedexRateGetter::VERSION
+  spec.authors       = ["Write your name"]
+  spec.email         = ["Write your email address"]
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "http://github.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'libxml-ruby', '~> 3.2.3'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.9.2'
+end

data/lib/fedex_rate_getter/connection.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+
+module FedexRateGetter
+	class Connection
+		API_URL = 'https://wsbeta.fedex.com:443/xml'
+
+		attr_accessor :api_connection
+
+		def initialize
+			@api_connection = Faraday.new(API_URL)
+		end
+
+		def get_rates(body)
+			api_connection.post(API_URL, body, 'Content-Type' => 'application/xml')
+		end
+	end
+end

data/lib/fedex_rate_getter/formatter/body.rb

@@ -0,0 +1,122 @@
+require 'libxml'
+
+module FedexRateGetter
+	module Formatter
+		class Body
+			attr_accessor :body
+
+			def initialize(credentials, quote_params)
+				@body = build_body(credentials, quote_params)
+			end
+
+			private
+
+			# Creates an XML as requested by the FedEx Api based on the given params
+			# @params {JSon} credentials, quote_params
+			def build_body(credentials, quote_params)
+				doc = create_doc
+
+				format_credentials(doc, credentials)
+				format_params(doc, quote_params)
+
+				doc.root.to_s
+			end
+
+
+			def format_credentials(doc, credentials)
+				# root
+				doc.root << (auth = create_node('WebAuthenticationDetail'))
+				doc.root << (client = create_node('ClientDetail'))
+				doc.root << (version = create_node('Version'))
+
+				# auth
+				auth << (user = create_node('UserCredential'))
+				user << create_node('Key', credentials[:user_credential][:key])
+				user << create_node('Password', credentials[:user_credential][:password])
+
+				# client
+				client << create_node('AccountNumber', credentials[:client_detail][:account_number])
+				client << create_node('MeterNumber', credentials[:client_detail][:metter_number])
+				client << (local = create_node('Localization'))
+				local << create_node('LanguageCode', credentials[:client_detail][:language_code].downcase)
+				local << create_node('LocaleCode', credentials[:client_detail][:locale_code].downcase)
+
+				# version
+				version << create_node('ServiceId', 'crs')
+				version << create_node('Major', 13)
+				version << create_node('Intermediate', 0)
+				version << create_node('Minor', 0)
+			end
+
+			def format_params(doc, quote_params)		
+				# root
+				doc.root << create_node('ReturnTransitAndCommit', true)
+				doc.root << (request = create_node('RequestedShipment'))
+
+				request << create_node('DropoffType', 'REGULAR_PICKUP')
+				request << create_node('PackagingType', 'YOUR_PACKAGING')
+				request << (shipper = create_node('Shipper'))
+				request << (recipient = create_node('Recipient'))
+
+				# shipper
+				shipper << (ship_address = create_node('Address'))
+				ship_address << create_node('StreetLines', quote_params[:address_from][:street_lines]&.upcase)
+				ship_address << create_node('City', quote_params[:address_from][:city]&.upcase)
+				ship_address << create_node('StateOrProvinceCode', 'XX')
+				ship_address << create_node('PostalCode', quote_params[:address_from][:zip])
+				ship_address << create_node('CountryCode', quote_params[:address_from][:country]&.upcase)
+
+
+				# recipient
+				recipient << (recip_address = create_node('Address'))
+				recip_address << create_node('StreetLines', quote_params[:address_to][:street_lines]&.upcase)
+				recip_address << create_node('City', quote_params[:address_to][:city]&.upcase)
+				recip_address << create_node('StateOrProvinceCode', 'XX')
+				recip_address << create_node('PostalCode', quote_params[:address_to][:zip])
+				recip_address << create_node('CountryCode', quote_params[:address_to][:country]&.upcase)
+				recip_address << create_node('Residential', false)
+
+				# shipping info
+				request << (ship_charges = create_node('ShippingChargesPayment'))
+				ship_charges << create_node('PaymentType', 'SENDER')
+				request << create_node('RateRequestTypes', 'ACCOUNT')
+				request << create_node('PackageCount', 1)
+
+				# parcel
+				request << (parcel = create_node('RequestedPackageLineItems'))
+				parcel << create_node('GroupPackageCount', 1)
+
+				parcel << (weight = create_node('Weight'))
+				weight << create_node('Units', quote_params[:parcel][:mass_unit]&.upcase)
+				weight << create_node('Value', quote_params[:parcel][:weight])
+
+				parcel << (dim = create_node('Dimensions'))
+				dim << create_node('Length', quote_params[:parcel][:length]&.to_i)
+				dim << create_node('Width', quote_params[:parcel][:width]&.to_i)
+				dim << create_node('Height', quote_params[:parcel][:height]&.to_i)
+				dim << create_node('Units', quote_params[:parcel][:distance_unit]&.upcase)
+			end
+
+			# Creates one node to the xml to be inserted
+			# @param {String} name of the node
+			# @param {String,Numeric,Boolean} value of the node
+			# @return [LibXML::XML::Node]
+			def create_node(name, value = nil)
+				node = LibXML::XML::Node.new(name)
+	    	node.content = value.nil? ? '' : value.to_s
+
+	    	node
+			end
+
+			# Creates the xml document
+			# @return[LibXML::XML::Document] doc 
+			def create_doc
+				doc = LibXML::XML::Document.new
+	    	doc.root = LibXML::XML::Node.new('RateRequest')
+	    	LibXML::XML::Attr.new(doc.root, 'xmlns', 'http://fedex.com/ws/rate/v13')
+	    	
+	    	doc
+			end
+		end
+	end
+end

data/lib/fedex_rate_getter/formatter/response.rb

@@ -0,0 +1,54 @@
+require 'active_support/core_ext/hash'
+
+module FedexRateGetter
+	module Formatter
+		class Response
+			attr_accessor :response, :hashed
+
+			# @Attribute[hashed] hash format extracted directly from fedex api xml
+			# @Attribute[response] json format
+			def initialize(response)
+				@hashed = Hash.from_xml(response)
+				@response = transform_response
+			end
+
+			private
+
+			# Transforms the xml given by fedex into a more readable hash
+			# @return [Array] response. An array with the rates
+			def transform_response
+				# If it fails will return the hashed response directly from FedExApi
+				return error unless hashed['RateReply']['HighestSeverity'] == 'SUCCESS'
+
+				response = hashed['RateReply']['RateReplyDetails'].map do |rate|
+					next if rate['ServiceType'].blank?
+
+					details = rate['RatedShipmentDetails'].last['ShipmentRateDetail']['TotalNetChargeWithDutiesAndTaxes']
+
+					{
+						price: details['Amount'],
+					 	currency: details['Currency'],
+					 	service_level: {
+					   name: beautify_type(rate['ServiceType']),
+					   token: rate['ServiceType'] 
+						}
+					}
+				end
+
+				response.compact
+			end
+
+			# Just an error
+			def error
+				{ error: hashed }
+			end
+
+			# Beautify the service type value
+			# @param {String} HELLO_WORLD
+			# @return [String] Hello world
+			def beautify_type(type)
+				type.gsub('_',' ').capitalize	
+			end
+		end
+	end
+end

data/lib/fedex_rate_getter/version.rb

@@ -0,0 +1,3 @@
+module FedexRateGetter
+  VERSION = "0.1.0"
+end

data/lib/fedex_rate_getter.rb

@@ -0,0 +1,34 @@
+require "fedex_rate_getter/version"
+require "fedex_rate_getter/connection"
+require "fedex_rate_getter/formatter/body"
+require "fedex_rate_getter/formatter/response"
+
+module FedexRateGetter
+  class Rate
+    attr_accessor :something
+    
+    def initialize
+      @something = 'hola mundo'
+    end
+
+    # Main method. returns shipping rate
+    # @params [Json, Json] credentials, quote_params
+    # @return [Array] array of requested rates
+    def self.get(credentials, quote_params)
+      # enable the api connection
+      connection = FedexRateGetter::Connection.new
+
+      # format body
+      body = FedexRateGetter::Formatter::Body.new(credentials, quote_params).body
+
+      # make a call to the api
+      res = connection.get_rates(body)
+
+      # return
+      FedexRateGetter::Formatter::Response.new(res.body).response
+    end
+
+    private
+
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: fedex_rate_getter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Write your name
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Write a longer description or delete this line.
+email:
+- Write your email address
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fedex_rate_getter.gemspec
+- lib/fedex_rate_getter.rb
+- lib/fedex_rate_getter/connection.rb
+- lib/fedex_rate_getter/formatter/body.rb
+- lib/fedex_rate_getter/formatter/response.rb
+- lib/fedex_rate_getter/version.rb
+homepage: http://github.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []