iupick 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ef9d8be0aafb0cd408311d5269f58f123a74544
-  data.tar.gz: 6487603a03e9d7744b57845ecc974ebd9e8f473f
+  metadata.gz: 2e65b0e7e4524d21a6542175eb7eeec47e8833ab
+  data.tar.gz: a8e4b556bd21e149d37982fadd908499f5ca55c1
 SHA512:
-  metadata.gz: 4f954acb9a0c2afd1e86e27703e7c949867d5b28beda736ad4902700bce28878d167bb5ba73f37e62ea32f9e0f2a884c5b6052fa6ce18e110a95686ed14f5b4d
-  data.tar.gz: 6b9c26d3367687476aafabed10aa23805974545e80eb13ee633d57eb0cf790a3b65ad4e70b5da775df46479f24e3c2a93a372b65e7709d6ae3ee84c28e76fe6b
+  metadata.gz: ce2af8fb42811258c93636f5325201e1c3891dc6c9003b2276ef0174ea1172c61cc337c422f48a43eed1b847cbf5ef89a9205252e9aea162a8eff35e7eb14a2f
+  data.tar.gz: 669d22866cdc269d67b8578fb1fc5dc8ce7bc6e344ac428e6850f482f84b90aa24bd9f58d80e41e002f7d18a38e8f85dcf33a708cd3a069d46528b69ca7aa295

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017, iupick
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,145 @@
+# Iupick
+
+The iupick Ruby gem wraps the iupick API to facilitate access from applications written in ruby.
+
+Keep in mind that this package requires iupick secret keys, contact
+info@iupick.com for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iupick'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iupick
+
+## Usage
+
+Add your secret and public tokens as required.
+
+Never expose your secret token.
+
+Methods that require your secret_token should never be done from the front-end. Since this methods deal with sensitive information.
+
+``` ruby
+require 'iupick'
+
+Iupick.secret_token = 'sk_sandbox_4bdcd3630417c5119029859c08a7b8d9d97dda79'
+Iupick.public_token = '315cdf3ca4dd588ab8e6f7fa4b7aa433c641cadd'
+Iupick.environment = 'sandbox'
+```
+
+## Waybills
+
+The waybill generation occurs on three steps.
+
+
+### Step 1.
+
+Create a shipment on the iupick platform and receive a
+shipment token.
+
+``` ruby
+shipment_token = Iupick::Shipment.create(length=8,width=8,height=8,weight=1.1)
+```
+
+### Step 2.
+
+Fill the rest of the information required to generate a waybill,
+and receive a confirmation token.
+
+You can send a shipment either to an arbitrary direction or to one
+of our waypoints; just replace the waypoint_id attribute for a recipient
+address.
+
+``` ruby
+shipper_address = Iupick.create_address(
+  city='Querétaro',
+  line_one='Epigmenio Gonzáles 500',
+  postal_code=76130,
+  line_two='',
+  neighborhood='Momma'
+)
+
+shipper_contact = Iupick.create_person(
+  person_name='Tony Stark',
+  phone_number='555555555',
+  email_address='tony@fakemail.com',
+  title='CEO',
+  company_name='Stark Industries',
+  phone_extension='123'
+)
+
+
+recipient_contact = Iupick.create_person(
+  person_name='Steve Rogers',
+  phone_number='555555555',
+  email_address='steve@fakemail.com',
+  title='Agent',
+  company_name='SHIELD',
+  phone_extension='123'
+)
+
+confirmation_token = Iupick::Shipment.add_information(
+  shipment_token = shipment_token,
+  waypoint_id = 486,
+  shipper_address = shipper_address,
+  shipper_contact = shipper_contact,
+  recipient_contact = recipient_contact,
+  third_party_reference = 'I am a shipment'
+)
+```
+
+### Step 3.
+
+Generate your waybill with your confirmation token.
+
+``` ruby
+waybill_information = Iupick::Shipment.generate_waybill(
+  confirmation_token = confirmation_token
+)
+```
+
+### Tracking your shipment
+
+In order to track a shipment send the carrier and the tracking number.
+
+``` ruby
+tracking_info = Iupick::Shipment.track(
+  carrier = carrier, tracking_number = tracking_number
+)
+```
+
+### Waypoints
+
+The Waypoints resource allows you to interact with all the delivery points from
+our network that are available to your account.
+
+To pull the full information for a single waypoint. Use `getWaypointInformation`
+It requires the waypoint unique id.
+
+``` ruby
+waypoint = Iupick::Waypoints.get_waypoint_information(waypoint_id = 20)
+```
+
+To get a list of all the coordinates of available waypoints, use
+`getWaypointsLite`.
+
+``` ruby
+waypoints = Iupick::Waypoints.get_waypoints_lite()
+```
+
+You can get all the waypoints close to a Postal Code with
+`getPostalCodeWaypoints`.
+
+``` ruby
+cp_waypoints = Iupick::Waypoints.get_postal_code_waypoints(postal_code = 95710)
+```

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iupick"
+
+# 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/lib/iupick.rb

@@ -0,0 +1,95 @@
+# Version
+require_relative "iupick/version"
+
+# Dependencies
+require 'unirest'
+require 'json'
+
+# API resources
+require_relative "iupick/shipment"
+require_relative "iupick/waypoint"
+
+module Iupick
+
+  class << self
+
+    attr_accessor :secret_token, :public_token, :environment
+
+    # Initializes the address dictionary with
+    # the values to be passed.
+    # This returns a dictionary for versatility.
+    def create_address(
+      city,
+      line_one,
+      postal_code,
+      line_two='',
+      neighborhood=''
+    )
+
+      return {
+        'city': city,
+        'line_one': line_one,
+        'line_two': line_two,
+        'neighborhood': neighborhood,
+        'postal_code': postal_code
+      }
+    end
+
+    # Initializes the an empty address
+    def empty_address()
+      return create_address(
+        city = 'Empty',
+        line_one = 'Empty',
+        postal_code = 'Empty',
+        line_two = 'Empty',
+        neighborhood = 'Empty'
+      )
+    end
+
+    # Initializes the person_object with
+    # the values to be passed.
+    # This returns a dictionary for versatility.
+    def create_person(
+      person_name,
+      phone_number,
+      email_address,
+      title = '',
+      company_name = '',
+      phone_extension = ''
+    )
+
+      return {
+        'person_name': person_name,
+        'phone_number': phone_number,
+        'email_address': email_address,
+        'title': title,
+        'company_name': company_name,
+        'phone_extension': phone_extension
+      }
+    end
+
+    # Gets the base url, to be used for the API service.
+    def get_base_url()
+      if environment == 'development'
+        return 'http://localhost:8000/api/'
+      elsif environment == 'sandbox'
+        return 'https://sandbox.iupick.com/api/'
+      elsif environment == 'production'
+        return 'https://iupick.com/api/'
+      end
+    end
+
+    # Returns the proper header either public or secret.
+    def generate_headers(auth)
+      if auth == 'public'
+        keyword = 'Token '
+        token = public_token
+      elsif auth == 'secret'
+        keyword = 'Secret '
+        token = secret_token
+      end
+      return {'Authorization': keyword + token}
+    end
+
+  end
+end

data/lib/iupick/shipment.rb

@@ -0,0 +1,94 @@
+module Iupick
+  # This is the class object for the shipments.
+  class Shipment
+
+    # Allows you to generate a token for the new shipment.
+    # Needs weight
+    # Needs Dimensions
+    # Receive a shipment id.
+    def self.create(length, width, height, weight)
+      url = Iupick.get_base_url() + 'create-shipment-token/'
+      headers = Iupick.generate_headers(auth = 'secret')
+      payload = {
+        'length': length.to_i,
+        'width': width.to_i,
+        'height': height.to_i,
+        'weight': weight.to_i
+      }
+
+      response = Unirest.post url,
+        headers: headers,
+        parameters: payload.to_json
+      decoded_response = response.body['shipment_token']
+    end
+
+    # This method allows you to fill the information required
+    # for the package, and receive a confirmation_token in exchange.
+    def self.add_information(
+      shipment_token,
+      waypoint_id,
+      shipper_address,
+      shipper_contact,
+      recipient_contact,
+      third_party_reference,
+      recipient_address = Iupick.empty_address()
+    )
+
+      waypoint_id = waypoint_id ? waypoint_id : nil;
+      recipient_address = recipient_address ?
+        recipient_address :
+        Iupick.emptyAddress();
+
+
+      if waypoint_id or recipient_address != Iupick.empty_address()
+        url = Iupick.get_base_url() +
+          'fill-shipment-information/' + shipment_token + '/'
+        headers = Iupick.generate_headers(auth = 'public')
+        payload = {
+          'waypoint': waypoint_id,
+          'shipper_address': shipper_address,
+          'shipper_contact': shipper_contact,
+          'recipient_address': recipient_address,
+          'recipient_contact': recipient_contact,
+          'third_party_reference': third_party_reference
+        }
+
+        response = Unirest.post url,
+          headers: headers,
+          parameters: payload.to_json
+        decoded_response = response.body['confirmation_token']
+        return decoded_response
+      end
+      return false
+    end
+
+    # Generates a waybill, once the information has been
+    # properly filled for the shipment.
+    def self.generate_waybill(confirmation_token)
+      url = Iupick.get_base_url() + 'generate-waybill/' + confirmation_token + '/'
+      headers = Iupick.generate_headers(auth = 'secret')
+
+      response = Unirest.post url,
+        headers: headers
+      decoded_response = response.body.to_json
+      return decoded_response
+    end
+
+    # Allows you to track the status of a shipment, with the
+    # tracking number and carrier.
+    def self.track(carrier, tracking_number)
+      url = Iupick.get_base_url() + 'track-shipment/'
+      payload = {
+        'carrier': carrier,
+        'tracking_number': tracking_number
+      }
+      headers = Iupick.generate_headers(auth = 'public')
+      response = Unirest.get url,
+        headers: headers,
+        parameters: payload
+      decoded_response = response.body['Message']
+    end
+
+  end
+end
+

data/lib/iupick/version.rb

@@ -0,0 +1,3 @@
+module Iupick
+  VERSION = "1.0.1"
+end

data/lib/iupick/waypoint.rb

@@ -0,0 +1,49 @@
+module Iupick
+  # This is the class object for the waypoints.
+  class Waypoints
+
+    # This method pulls the complete information for a single waypoint.
+    def self.get_waypoint_information(waypoint_id)
+      if waypoint_id
+        url = Iupick.get_base_url() + 'waypoints/' + waypoint_id.to_s + '/'
+        headers = Iupick.generate_headers(auth = 'public')
+
+        response = Unirest.get url,
+          headers: headers
+        decoded_response = response.body
+        return decoded_response
+      else
+        return {
+          'error': 'No es posible obtener la informacion del punto ' + waypoint_id.to_s
+        }
+      end
+    end
+
+    # This method allows you to pull the basic information required to plot
+    # the waypoints in a map
+    def self.get_waypoints_lite()
+      url = Iupick.get_base_url() + 'waypoints/lite/'
+      headers = Iupick.generate_headers(auth = 'public')
+
+      response = Unirest.get url,
+        headers: headers
+
+      decoded_response = response.body
+      return decoded_response
+    end
+
+    # This method allows you to pull the full information for waypoints in a
+    # certain postal code
+    def self.get_postal_code_waypoints(postal_code)
+      url = Iupick.get_base_url() + 'waypoints/postal-ids/' + postal_code.to_s + '/'
+      headers = Iupick.generate_headers(auth='public')
+
+      response = Unirest.get url,
+        headers: headers
+
+      decoded_response = response.body
+      return decoded_response
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iupick
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Franco Valencia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2017-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +44,15 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/iupick.rb
+- lib/iupick/shipment.rb
+- lib/iupick/version.rb
+- lib/iupick/waypoint.rb
 homepage: https://github.com/iupickmx/iupick-ruby
 licenses:
 - MIT