RubyGems - aceroute - Versions diffs - 0.2 - Mend

aceroute 0.2

Files changed (46) hide show

checksums.yaml +7 -0
data/.gitignore +8 -0
data/.rspec +2 -0
data/.travis.yml +3 -0
data/Gemfile +6 -0
data/LICENSE +22 -0
data/LICENSE.txt +21 -0
data/README.md +63 -0
data/Rakefile +3 -0
data/aceroute.gemspec +34 -0
data/bin/console +14 -0
data/bin/setup +7 -0
data/doc/.yardoc/checksums +3 -0
data/doc/.yardoc/object_types +0 -0
data/doc/.yardoc/objects/root.dat +0 -0
data/doc/.yardoc/proxy_types +0 -0
data/doc/AceRoute_API.pdf +0 -0
data/doc/Aceroute/Base.html +135 -0
data/doc/Aceroute/Customer.html +949 -0
data/doc/Aceroute/Location.html +1111 -0
data/doc/Aceroute/Order.html +1458 -0
data/doc/Aceroute.html +1401 -0
data/doc/Hashit.html +212 -0
data/doc/_index.html +183 -0
data/doc/class_list.html +58 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +156 -0
data/doc/file_list.html +60 -0
data/doc/frames.html +26 -0
data/doc/index.html +156 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +181 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +345 -0
data/doc/top-level-namespace.html +114 -0
data/lib/aceroute/base.rb +20 -0
data/lib/aceroute/core.rb +192 -0
data/lib/aceroute/customer.rb +69 -0
data/lib/aceroute/hashit.rb +12 -0
data/lib/aceroute/location.rb +62 -0
data/lib/aceroute/order.rb +81 -0
data/lib/aceroute/version.rb +3 -0
data/lib/aceroute.rb +5 -0
metadata +146 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,114 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!top-level-namespace.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Aceroute.html" title="Aceroute (module)">Aceroute</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Hashit.html" title="Hashit (class)">Hashit</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Sun Dec  4 11:17:52 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.3.1).
+</div>
+  </body>
+</html>

data/lib/aceroute/base.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module Aceroute
+# Base class for all other Aceroute module classes to extend.
+class Base
+  protected
+  #takes a Hashit class, extracts the instance variables, and sets them on our instance
+  # @param hashit [Hashit] Hashit object, typically created from a response from Aceroute API
+  def update_attrs(hashit)
+    hashit.instance_variables.each do |name|
+      singleton_class.class_eval {attr_accessor "#{name[1..-1]}"} #remove leading @ from varname
+      send("#{name[1..-1]}=", hashit.instance_variable_get(name))
+    end
+  end
+end
+end

data/lib/aceroute/core.rb ADDED Viewed

@@ -0,0 +1,192 @@
+require 'rubygems'
+require 'httparty'
+require 'aceroute/base'
+require 'aceroute/hashit'
+require 'aceroute/customer'
+require 'aceroute/location'
+require 'aceroute/order'
+module Aceroute
+  include HTTParty
+  @@DEBUG = false
+  debug_output $stdout if @@DEBUG
+  attr_accessor :http_result
+  base_uri 'http://air.aceroute.com'
+  @@API_KEY = ENV['ACEROUTE_API_TOKEN']
+  @@query_params = {
+    token: @@API_KEY,
+    updsince: '0'
+  }
+  # List all customers
+  # @return [Hash] list of customer objects
+  def self.list_customers
+    customers = []
+    res = self.call_api("customer.list", nil)
+    res.cnts.cnt.each do |r|
+      c = Aceroute::Customer.new(name: r['nm'], email: r['eml'], cid: r['cid'])
+      customers << c
+      #find corresponding addresses for this customer
+      locations = res.locs.loc.find_all{|l| l["cid"] == c.cid }
+      locations.each do |a|
+        c.locations << Aceroute::Location.new(address1: a['adr'], address2: a['adr2'],
+          phone: a['tel'], description: a['nm'])
+      end
+    end
+    customers
+  end
+  # Create a new customer
+  # @param customer [Hash]
+  #   * :name (String) the name of customer
+  #   * :email (String) the email for this customer
+  #   * :address [Hash]
+  #     * :description (String) the description of this address, eg 'home'
+  #     * :address1 (String) line 1 of the address, eg '123 Fake Street'
+  #     * :address2 (String) line 2 of the address, eg 'New York, NY 12345'
+  #     * :name (String) address name
+  #     * :phone (String) address phone number
+  # @return [Hash] customer and address
+  def self.create_customer(customer)
+    recs = "<data>
+      <cst>
+        <nm>#{customer[:name]}</nm>
+        <locnm>#{customer[:address][:description]}</locnm>
+        <adr>#{customer[:address][:address1]}</adr>
+        <adr2>#{customer[:address][:address2]}</adr2>
+        <cntnm>#{customer[:address][:name]}</cntnm>
+        <tel>#{customer[:address][:phone]}</tel>
+        <eml>#{customer[:email]}</eml>
+      </cst>
+    </data>"
+    data = self.call_api("customer.create", recs)
+    location = data.locs.loc
+    customer = data.cnts.cnt
+    return customer, location
+  end
+  # Delete a customer
+  # @param customer_id [Integer] id of Aceroute Customer object
+  # @return success or failure hash
+  def self.delete_customer(customer_id)
+    recs = "<data><del><id>#{customer_id}</id></del></data>"
+    self.call_api("customer.delete", recs)
+  end
+  # Create a new location
+  # @param location [Hash]
+  #   * :id (Integer)
+  #   * :description (String) the description of this address, eg 'home'
+  #   * :address1 (String) line 1 of the address, eg '123 Fake Street'
+  #   * :address2 (String) line 2 of the address, eg 'New York, NY 12345'
+  #   * :customer
+  #     * :cid (Integer) cid from Aceroute Customer object
+  # @return Aceroute location object
+  def self.create_location(location)
+    recs = "<data><loc><id>#{location[:id]}</id>
+      <cid>#{location[:customer][:cid]}</cid>
+      <nm>#{location[:description]}</nm>
+      <adr>#{location[:address1]}</adr>
+      <adr2>#{location[:address2]}</adr2>
+      </loc></data>"
+    data = self.call_api("customer.location.save", recs)
+    loc = data.loc
+  end
+  # Delete a location
+  # @param location_id (Integer) id from Aceroute Location object
+  # @return nil
+  def self.delete_location(location_id)
+    recs = "<data><del><id>#{location_id}</id></del></data>"
+    types = self.call_api("customer.location.delete", recs).otype
+  end
+  # List order types
+  # @return list of available order types for this account
+  def self.list_order_types
+    self.call_api("order.type.list", nil)
+  end
+  # List service types
+  # @return list of available service types for this account
+  def self.list_service_types
+    self.call_api("product.type.list", nil)
+  end
+  # List all workers
+  # @return list of available workers for this account
+  def self.list_workers
+    workers = self.call_api("worker.list", nil).res
+  end
+  # List all orders
+  # @return list of all orders in this account
+  def self.list_orders
+    workers = self.call_api("order.list", nil).event
+  end
+  # Create new order
+  # @param order [Hash]
+  #   * :cid (Integer) Aceroute customer id
+  #   * :nm (String) 'name', descriptive field for this order
+  #   * :dir (Integer) 'duration', in 5 minute increments
+  #   * :sched (Integer) 1 = scheduled, 0 = unscheduled
+  #   * :start_epoch (Integer) time in msec since epoch
+  #   * :lid (Integer) optional -- customer location id
+  #   * :cntid (Integer) optional -- customer contact id
+  #   * :rid (Integer) optional -- worker id, to assign this order to a specific worker
+  #   * :dtl (String) optional -- order summary
+  #   * po (String) optional -- 'purchase order', descriptive field for use as desired
+  # @return Aceroute Order object
+  def self.create_order(order)
+    recs = "<data>
+          <event>
+            <cid>#{order[:cid]}</cid>
+            <nm>#{order[:nm]}</nm>
+            <dur>#{order[:dur]}</dur>
+            <schd>#{order[:schd]}</schd>
+            <start_epoch>#{order[:start_epoch]}</start_epoch>
+            <lid>#{order[:lid]}</lid>
+            <cntid>#{order[:cntid]}</cntid>
+            <rid>#{order[:rid]}</rid>
+            <dtl>#{order[:dtl]}</dtl>
+            <po>#{order[:po]}</po>
+          </event>
+        </data>"
+    puts recs if @@DEBUG
+    data = self.call_api("order.create", recs)
+    puts data if @@DEBUG
+    order = data.event
+  end
+  # Delete an order
+  def self.delete_order(order_id)
+    recs = "<data><del><id>#{order_id}</id></del></data>"
+    self.call_api("order.delete", recs)
+  end
+private
+  def self.call_api(method, recs)
+    params = @@query_params.merge!({method: method})
+    params[:recs] = recs unless recs.nil?
+    options = {query: params}
+    http_result = self.get("/api", options).parsed_response
+    puts http_result if @@DEBUG
+    data = Hashit.new(http_result['data'])
+  end
+end

data/lib/aceroute/customer.rb ADDED Viewed

@@ -0,0 +1,69 @@
+module Aceroute
+class Customer < Base
+  attr_accessor :locations
+  attr_accessor :email
+  attr_accessor :name
+  attr_accessor :cid, :id
+  #Creates a new Aceroute::Customer object. Note this does not
+  #persist the Customer to Aceroute, that can be done by calling the
+  #create! method on the new object.
+  # @param name [String] customer name
+  # @param email [String] customer email
+  # @param location [Hash] customer Location, optional
+  # @param cid [Integer] Aceroute customer id, optional; useful for instantiating Customer objects from Aceroute API response
+  # @return [Aceroute::Customer]
+  def initialize(name, email, location = {}, cid = nil)
+    self.locations = []
+    #create getters/setters for each param
+    self.email = email
+    self.name = name
+    self.cid = cid
+    if !location.empty?
+      locations << Aceroute::Location.new(location[:address1], location[:address2], location[:description],
+      location[:name], location[:phone])
+    end
+  end
+  # Persists Customer object to Aceroute API.
+  # @return [Aceroute::Customer]
+  def create!
+    recs = "<data>
+      <cst>
+        <nm>#{self.name}</nm>
+        <locnm>#{self.locations.first.description}</locnm>
+        <adr>#{self.locations.first.address1}</adr>
+        <adr2>#{self.locations.first.address2}</adr2>
+        <cntnm>#{self.locations.first.name}</cntnm>
+        <tel>#{self.locations.first.phone}</tel>
+        <eml>#{self.email}</eml>
+      </cst>
+    </data>"
+    #puts recs
+    data = Aceroute::call_api("customer.create", recs)
+    location = data.locs.loc
+    customer = data.cnts.cnt
+    update_attrs(customer)
+    self.cid = customer.cid
+    locations.first.update_attrs(location)
+    return self
+  end
+  # Deletes this Aceroute::Customer object (self) from Aceroute;
+  def destroy!(id = nil)
+    Customer.delete(id ? id : self.cid)
+  end
+  # Deletes Aceroute::Customer of given id from Aceroute
+  # @param id [Integer]
+  def self.delete(id)
+    recs = "<data><del><id>#{id}</id></del></data>"
+    ret = Aceroute::call_api("customer.delete", recs)
+    ret.success == "true" ? true : false
+  end
+end
+end

data/lib/aceroute/hashit.rb ADDED Viewed

@@ -0,0 +1,12 @@
+class Hashit
+  def initialize(hash)
+    hash.nil? ? return : nil
+    hash.each do |k,v|
+      self.instance_variable_set("@#{k}", v.is_a?(Hash) ? Hashit.new(v) : v)
+      self.class.send(:define_method, k, proc{self.instance_variable_get("@#{k}")})
+      self.class.send(:define_method, "#{k}=", proc{|v| self.instance_variable_set("@#{k}", v)})
+    end
+  end
+end

data/lib/aceroute/location.rb ADDED Viewed

@@ -0,0 +1,62 @@
+module Aceroute
+class Location < Base
+  attr_accessor :address1
+  attr_accessor :address2
+  attr_accessor :description
+  attr_accessor :name
+  attr_accessor :phone
+  attr_accessor :cid, :id
+  #Creates a new Aceroute::Location object. Note this does not
+  #persist the Location to Aceroute, that can be done by calling the
+  #create! method on the new object.
+  # @param address1 [String] customer address line 1 (street)
+  # @param address2 [String] customer address line 2 (eg apartment number)
+  # @param description [String] description of address (eg 'Home')
+  # @param name [String] name of address (eg 'Home')
+  # @param phone [String] phone number associated with this address
+  # @param cid [Integer] Aceroute customer id, optional; associates this Location with that Customer
+  # @param id [Integer] Aceroute location id, optional; useful for instantiating Location objects from Aceroute API response
+  # @return [Aceroute::Location]
+  def initialize(address1, address2, description, name, phone, cid = nil, id= nil)
+    self.address1 = address1
+    self.address2 = address2
+    self.description = description
+    self.name = name
+    self.phone = phone
+    self.cid = cid
+    self.id = id
+  end
+  # Persists Aceroute::Location object to Aceroute API.
+  # @return [Aceroute::Location]
+  def create!
+    recs = "<data><loc><id>0</id>
+      <cid>#{self.cid}</cid>
+      <nm>#{self.description}</nm>
+      <adr>#{self.address1}</adr>
+      <adr2>#{self.address2}</adr2>
+      </loc></data>"
+    data = Aceroute::call_api("customer.location.save", recs)
+    loc = data.loc
+    update_attrs(loc)
+    return self
+  end
+  # Deletes this Aceroute::Location object (self) from Aceroute
+  def destroy!(id = nil)
+    Location.delete(id ? id : self.id)
+  end
+  # Deletes Aceroute::Location of given id from Aceroute
+  # @param id [Integer]
+  def self.delete(id)
+    req = "<data><del><id>#{id}</id></del></data>"
+    ret = Aceroute::call_api("customer.location.delete", req)
+    ret.success == "true" ? true : false  #maybe raise error here instead
+  end
+end
+end

data/lib/aceroute/order.rb ADDED Viewed

@@ -0,0 +1,81 @@
+module Aceroute
+class Order < Base
+  attr_accessor :customer, :location, :start_time #in msec (not sec) since epoch
+  attr_accessor :description, :duration, :scheduled, :worker, :summary, :purchase_order #any freeform text here
+  attr_accessor :cid, :id
+  #Creates a new Aceroute::Order object. Note this does not
+  #persist the Location to Aceroute, that can be done by calling the
+  #create! method on the new object.
+  # @param customer [Aceroute::Customer] recipient of this Order
+  # @param location [Aceroute::Location] location of this Order (delivery destination)
+  # @param start_time [Integer] start time of Order, in msec since epoch (note: msec not sec)
+  # @param description [String] description of Order (e.g., contents of order)
+  # @param duration [Integer] duration of Order in minutes (time to service customer); used to aid in route optimization. Defaults to 10 minutes
+  # @param scheduled [Boolean] whether this Order is scheduled or not; defaults to true
+  # @param worker [Integer] Worker ID of aceroute worker to assign this Order to; defaults to nil (not implemented)
+  # @param summary [String] Summary of order, to be displated in app. Defaults to none.
+  # @param purchase_order [String] arbitrary string to indicate PO or other note, if needed
+  # @return [Aceroute::Order]
+  def initialize(customer, location, start_time, description = nil, duration = 10,
+    scheduled = true, worker = nil, summary = nil, purchase_order = nil)
+    self.customer = customer
+    self.location = location
+    self.start_time = start_time
+    #FIXME: taking a DateTime argument is friendlier
+    #self.start_time = start_time.to_i * 1000 #DateTime object
+    self.description = description
+    self.duration = duration
+    self.scheduled = scheduled
+    self.worker = worker
+    self.summary = summary
+    self.purchase_order = purchase_order
+  end
+    # Persists Aceroute::Order object to Aceroute API.
+    # @return [Aceroute::Order]
+    def create!
+      recs = "<data>
+            <event>
+              <cid>#{self.customer.cid}</cid>
+              <nm>#{self.description}</nm>
+              <dur>#{self.duration}</dur>
+              <schd>#{self.scheduled ? 1 : 0}</schd>
+              <start_epoch>#{self.start_time}</start_epoch>
+              <lid>#{self.location.id}</lid>
+              <cntid>#{0}</cntid>
+              <rid>#{self.worker}</rid>
+              <dtl>#{self.summary}</dtl>
+              <po>#{self.purchase_order}</po>
+            </event>
+          </data>"
+      data = Aceroute::call_api("order.create", recs)
+      order = data.event
+      update_attrs(order)
+      return self
+    end
+    # Deletes this Aceroute::Order object (self) from Aceroute
+    def destroy!(id = nil)
+      Order.delete(id ? id : self.id)
+    end
+    # Deletes Aceroute::Location of given id from Aceroute
+    # @param id [Integer]
+    def self.delete(id)
+      req = "<data><del><id>#{id}</id></del></data>"
+      ret = Aceroute::call_api("order.delete", req)
+      ret.success == "true" ? true : false  #maybe raise error here instead
+    end
+end
+end

data/lib/aceroute/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Aceroute
+  VERSION = "0.2"
+end

data/lib/aceroute.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require "aceroute/version"
+require "aceroute/core"
+module Aceroute
+  # Your code goes here...
+end