fedex_location_service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af84ccb95688e10d48bd4db5a079c25f70406a8192080756d6d51e28c6407fa6
+  data.tar.gz: 5dc0413853f9442227615134fd259579224378d7a34edc639a54501e7de150a2
+SHA512:
+  metadata.gz: e3ffae7a1ec1dc4d8f9fe40d906a28a82547a753f908be5b182dc90967fd59e817fd2cf68854202e808d51b5efc6eb522db92db003f6cd500923794f587f488f
+  data.tar.gz: c5f5bcf3e2ab5d63b159db37bf86782fa243376e0439964e6800402a599493311e51b33ff0ddaa28c210d80ae4816ccc5c5a1e16fd196db4cb90ae62f247e14c

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# dotenv config
+.env
+
+# simplecov
+/coverage
+
+# vcr cassettes
+/spec/vcr/**/*.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.4@location_service --create

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in location_service.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Casey Ellett
+
+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,73 @@
+# LocationService
+
+This gem interfaces with the FedEx Location Services API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fedex_location_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fedex_location_service
+
+## Usage
+
+In order to use the FedEx API you will need to sign up for a FedEx Webservices account and receive your own test and production credentials.
+
+These credentials can be configured by using the following configuration block:
+
+```ruby
+FedexLocationService.configure do |c|
+  c.wsdl           = 'WSDL URL'
+  c.key            = 'KEY'
+  c.password       = 'PASSWORD'
+  c.account_number = 'ACCOUNT NUMBER'
+  c.meter_number   = 'METER NUMBER'
+end
+```
+
+In order to build a message to pass to the FedEx API you will need to create an address object that resonds to the following:
+
+address_one
+address_two
+city
+state
+postal_code
+
+This can be done with a Struct or with active_record address model. This can then be passed to FedexLocationService::Message.build() to generate the proper SOAP message.
+
+Example:
+
+```ruby
+Address = Struct.new(:address_one, :address_two, :city, :state, :postal_code)
+
+addr = Address.new('6008 W Broad St.', nil, 'Richmond', 'VA', '23230')
+
+message = FedexLocationService::Message.build(addr)
+```
+
+The resulting message can then be passed to FedexLocationService::Request.call().
+
+This will return a Savon object that you can parse.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/odin/location_service.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "location_service"
+
+# 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_location_service.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fedex_location_service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fedex_location_service"
+  spec.version       = FedexLocationService::VERSION
+  spec.authors       = ["odin - (Casey Ellett)"]
+  spec.email         = ["casey.ellett@gmail.com"]
+
+  spec.summary       = %q{Interface for FedEx Location Services API.}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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_development_dependency "awesome_print"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'savon'
+end

data/lib/fedex_location_service.rb

@@ -0,0 +1,29 @@
+require 'fedex_location_service/configuration'
+require 'fedex_location_service/locations'
+require 'fedex_location_service/message'
+require 'fedex_location_service/request'
+require 'fedex_location_service/version'
+
+require 'savon'
+
+module FedexLocationService
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.root
+    Pathname.new File.expand_path('../..', __FILE__)
+  end
+end

data/lib/fedex_location_service/configuration.rb

@@ -0,0 +1,17 @@
+module FedexLocationService
+  class Configuration
+    attr_accessor :wsdl
+    attr_accessor :key
+    attr_accessor :password
+    attr_accessor :account_number
+    attr_accessor :meter_number
+
+    def initialize
+      @wsdl           = nil
+      @key            = nil
+      @password       = nil
+      @account_number = nil
+      @meter_number   = nil
+    end
+  end
+end

data/lib/fedex_location_service/locations.rb

@@ -0,0 +1,25 @@
+module FedexLocationService
+  class Locations
+    def self.call(response)
+      locations = response.body[:search_locations_reply][:address_to_location_relationships][:distance_and_location_details]
+
+      location_details = []
+
+      locations.each do |location|
+        address = {
+          company_name: location[:location_detail][:location_contact_and_address][:contact][:company_name],
+          street:       location[:location_detail][:location_contact_and_address][:address][:street_lines],
+          city:         location[:location_detail][:location_contact_and_address][:address][:city],
+          state:        location[:location_detail][:location_contact_and_address][:address][:state_or_province_code],
+          postal_code:  location[:location_detail][:location_contact_and_address][:address][:postal_code],
+          distance:     location[:distance][:value],
+          map_url:      location[:location_detail][:map_url]
+        }
+
+        location_details << address
+      end
+
+      return location_details
+    end
+  end
+end

data/lib/fedex_location_service/message.rb

@@ -0,0 +1,58 @@
+module FedexLocationService
+  class Message
+    def self.build(configuration, address)
+      { 'WebAuthenticationDetail' => [
+          'ParentCredential' => [
+            'Key' => configuration.key,
+            'Password' => configuration.password
+          ],
+          'UserCredential' => [
+            'Key' => configuration.key,
+            'Password' => configuration.password
+          ]
+        ],
+        'ClientDetail' => [
+          'AccountNumber' => configuration.account_number,
+          'MeterNumber' => configuration.meter_number
+        ],
+        'TransactionDetail' => [
+          'CustomerTransactionId' => 'location_service gem'
+        ],
+        'Version' => [
+          'ServiceId' => 'locs',
+          'Major' => '7',
+          'Intermediate' => '0',
+          'Minor' => '0'
+        ],
+        'EffectiveDate' => Date.today.to_s,
+        'LocationsSearchCriterion' => 'ADDRESS',
+        'Address' => [
+          'StreetLines' => [
+            address.address_one,
+            ## address_two cannot be nil
+            address.address_two ? address.address_two : ''
+          ],
+          'City' => address.city,
+          'StateOrProvinceCode' => address.state,
+          'PostalCode' => address.postal_code,
+          'CountryCode' => 'US'
+        ],
+        'MultipleMatchesAction' => 'RETURN_ALL',
+        'SortDetail' => [
+          'Criterion' => 'DISTANCE',
+          'Order' => 'LOWEST_TO_HIGHEST'
+        ],
+        'Constraints' => [
+          'RadiusDistance' => [
+            'Value' => 15.0,
+            'Units' => 'MI'
+          ],
+          'RequiredLocationAttributes' => [
+            'WEEKDAY_EXPRESS_HOLD_AT_LOCATION'
+          ],
+          'ResultsRequested' => 5,
+        ]
+      }
+    end
+  end
+end

data/lib/fedex_location_service/request.rb

@@ -0,0 +1,15 @@
+module FedexLocationService
+  class Request
+    def self.call(message)
+      client = Savon.client(wsdl: FedexLocationService.configuration.wsdl)
+
+      begin
+        @response = client.call(:search_locations, message: message)
+      rescue Savon::SOAPFault => error
+        puts error.http.inspect
+      end
+
+      return @response
+    end
+  end
+end

data/lib/fedex_location_service/version.rb

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

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: fedex_location_service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- odin - (Casey Ellett)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- casey.ellett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fedex_location_service.gemspec
+- lib/fedex_location_service.rb
+- lib/fedex_location_service/configuration.rb
+- lib/fedex_location_service/locations.rb
+- lib/fedex_location_service/message.rb
+- lib/fedex_location_service/request.rb
+- lib/fedex_location_service/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Interface for FedEx Location Services API.
+test_files: []