shadowfax_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a56880610ffb59913514cdd0aae13da0d848b42e
+  data.tar.gz: f7d17e721483ac8d2bd2499fd0660a7c0b638b17
+SHA512:
+  metadata.gz: b1ed967ba624448564d4bbd9427fe13401c28961ff18276bee24b1242c256185c385b0f6a2eac35d65cc8e707ee0b6235826bd998871a1ad238a5c347444fb1f
+  data.tar.gz: 9f8e1e5bb846e8e850cb199fa6519803aebc86edfcd55842e3e3434c978052f46953723776786592220d97537989dfcc4820c3cce3f7cb00bb2d2a01891a5a1d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tabish.maniar@mirraw.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in shadowfax_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tabish Maniar
+
+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,86 @@
+# ShadowfaxApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shadowfax_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shadowfax_api'
+```
+
+And then execute:
+```ruby
+    bundle
+```
+
+Or install it yourself as:
+
+```ruby
+    gem install shadowfax_api
+```
+
+**Add shadowfax.yml in config file as**
+    
+```ruby
+    environment_name:
+      url: given_url
+      key: given_key
+```
+
+**If you want to specific config file then you can use this method for initializing the configuration
+```ruby
+    ShadowfaxApi::Configuration::Config.load("config/shadowfax.yml",env: Rails.env)
+```
+
+
+## Usage
+
+
+
+Get Serviceable Pincodes
+```ruby
+    ShadowfaxApi.get_servicable_pincodes
+````
+
+Get Response if particular pincode is serviceable
+```ruby
+    ShadowfaxApi.check_serviceable_pincode
+```
+Generate Package
+```ruby
+    ShadowfaxApi.create_package(package_data)
+```
+
+Get Package Details
+```ruby
+    ShadowfaxApi.get_delivery_details(awb_number)
+```
+
+Get Bulk Package Details
+```ruby
+    ShadowfaxApi.get_bulk_query(awb_data)
+```
+
+Cancel Delivery Request
+```ruby
+    ShadowfaxApi.cancel_delivery_request(data)
+```
+
+## 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/Tabish06/shadowfax_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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 "shadowfax_api"
+
+# 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

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/lib/shadowfax_api.rb

@@ -0,0 +1,4 @@
+require "shadowfax_api/version"
+require 'shadowfax_api/shadowfax_api.rb'
+require 'shadowfax_api/config.rb'
+require 'shadowfax_api/exception.rb'

data/lib/shadowfax_api/config.rb

@@ -0,0 +1,33 @@
+require 'erb'
+require 'yaml'
+module ShadowfaxApi
+  module Configuration
+    def self.config
+      @config ||= Config.config
+    end
+
+    class Config
+      def self.load(file_name,env: :development)
+        @@default_environment = env
+        @@configurations      = read_configurations(file_name)
+        config
+      end
+
+      def self.default_environment
+        @@default_environment ||= (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || :development).to_sym
+      end
+
+
+      def self.config
+        (@@configurations      ||= read_configurations)[default_environment]
+      end
+
+      private
+      def self.read_configurations(file_name = "config/shadowfax.yml")
+        erb = ERB.new(File.read(file_name))
+        erb.filename = file_name
+        YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(erb.result) : YAML.load(erb.result)
+      end
+    end
+  end
+end

data/lib/shadowfax_api/exception.rb

@@ -0,0 +1,7 @@
+module ShadowfaxApi
+  class Exception < ::Exception
+    def self.raise_exception(exception_response)
+      new(exception_response)
+    end
+  end
+end

data/lib/shadowfax_api/shadowfax_api.rb

@@ -0,0 +1,63 @@
+require 'httparty'
+require 'logger'
+module ShadowfaxApi
+  class << self
+    def logger
+      @logger ||= begin
+        logger= Logger.new(STDOUT)
+        logger.level = Logger::WARN
+        logger
+      end
+    end
+
+    def logger=(logger)
+      @logger=logger
+    end
+
+    def get_servicable_pincodes
+      response = send_request(url('serviceable_pincodes'),respond: 'requests')
+    end
+
+    def check_serviceable_pincode(pincode)
+      response = send_request(url('check_serviceable_pincodes',pincode.to_s))
+    end
+
+    def get_delivery_details(awb_number)
+      response = send_request(url(awb_number))
+    end
+
+    def cancel_delivery_request(data)
+      send_request(url('cancel_order'),method: :put,data: data)
+    end
+
+    def create_package(data)
+      send_request(url,method: :post,data: data)
+    end
+
+    def get_bulk_query(data)
+      send_request(url('bulk_query'),method: :post,data: data)
+    end
+
+    private
+    def url(*args)
+      args.size == 0 ? Configuration.config[:url] :
+        "#{Configuration.config[:url]}/" + args.join("/")
+    end
+
+    def send_request(url,method: :get,data: nil,respond: nil)
+      options = {headers: headers}
+      options[:body] = data.to_json if data
+      response = HTTParty.send(method,url,options)
+      logger.debug(response.to_s)
+      if respond.present?
+        response[respond] || Exception.raise_exception(response)
+      else
+        JSON.parse(response.body)
+      end
+    end
+
+    def headers
+      @headers ||= {'Authorization' => "Token #{Configuration.config[:key]}", 'Content-Type' => 'application/json'}.freeze
+    end
+  end
+end

data/lib/shadowfax_api/version.rb

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

data/shadowfax_api.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shadowfax_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shadowfax_api"
+  spec.version       = ShadowfaxApi::VERSION
+  spec.authors       = ["Tabish Maniar"]
+  spec.email         = ["tabish.maniar@gmail.com"]
+
+  spec.summary       = %q{Shadowfax courier integration gem. }
+  spec.description   = %q{Shadowfax courier integration to give you access to different api endpoints passing the required parameters}
+  spec.homepage      = "https://github.com/Tabish06/ShadowFax-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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'httparty', "~> 0.8"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: shadowfax_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tabish Maniar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Shadowfax courier integration to give you access to different api endpoints
+  passing the required parameters
+email:
+- tabish.maniar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shadowfax_api.rb
+- lib/shadowfax_api/config.rb
+- lib/shadowfax_api/exception.rb
+- lib/shadowfax_api/shadowfax_api.rb
+- lib/shadowfax_api/version.rb
+- shadowfax_api.gemspec
+homepage: https://github.com/Tabish06/ShadowFax-Api
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Shadowfax courier integration gem.
+test_files: []