weighflow_cli 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2832116659539919d396f7461858ed6257755b6c7c86356aa87f099c126fb637
-  data.tar.gz: 395c8a76161378454bb3d0083e3410f489c07b7f2450a7594d4d7c9ed868bf43
+  metadata.gz: 6f43616755fac94a4e1b1afc3095bdfd03ac5dc50dd2b42ee5ae838cf6023f37
+  data.tar.gz: 4710b9900bca368eb76a530a15e15681357f513efdb2bdf559ce29e36393f7ba
 SHA512:
-  metadata.gz: 5e20d405fe9ce4fafbd0cb91edac5f89825b1b7dfa555d5b5cd086b8ecac3589ee5865f31efe9f9f6a2c309417069a52a69d2ad62e6e06d476760db9ce628b16
-  data.tar.gz: 20b78c91b1d66d61c2669690b041ac5e27393a33314d0044f5aff8bfd26be6ea90a39c0c0cf9d66db01fcfee3a109431cd9de99cdf9c399a3df535c57359bc7f
+  metadata.gz: 8afc73d0d13f07e9f1b893f80040b4dd4d5fa02ad664e7dc55e3567eb9430687cfe9ab956aac8c93bcef93fa80cceb0aa1940010203c2fdc67fbb2fb0f34c7a8
+  data.tar.gz: ce913eb0ba65a20389c685c1a5aa4a4f51cd90f2d036949c9ae40930da53b49eecb9ec7bcc1e1dc2dd3ef64666841ba71a18117888daac1309b6f4a69d94c72b

data/.byebug_history

@@ -1,4 +1,19 @@
 c
+weight_params
+c
+weight_params
+q
+weight_params
+c
+weight_params
+q
+weight_params
+ap weight_params
+c
+ap weight_params
+require 'awesome_print'
+ap weight_params
+c
 commodity_inbounds[:orders]
 inventory_inbounds[:orders]
 inventory_outbounds[:orders]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weighflow_cli (0.2.3)
+    weighflow_cli (0.2.4)
       httparty
       thor (~> 1.1.0)
 

data/README.md

@@ -22,13 +22,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+From a console prompt simple type:
 
-## Development
+```bash
 
-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.
+    $ weighflow_cli
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+
+Follow menu instructions
 
 ## Contributing
 

data/lib/weighflow_cli.rb

@@ -16,18 +16,26 @@ module WeighflowCli
   class Error < StandardError; end
   # 
   _ROOT_PATH = File.expand_path('~/.weighflow_cli').freeze
+  #
   Dir.mkdir(_ROOT_PATH) unless Dir.exists?(_ROOT_PATH)
   #
-  # Provide an orderride to relocate data directory
+  # Provide an override to relocate data directory
   DATA_PATH = ENV['WEIGHFLOW_CLI_PATH'] || File.join(_ROOT_PATH, 'data')
   #
   #
-  # ensure data path
+  # Ensure data path
   Dir.mkdir(DATA_PATH) unless Dir.exists?(DATA_PATH)
    #
   
    Configuration = Struct.new(:secret, :url)
 
+   ##
+   # This can be used to set the +secret+ and +url+ for api credentials
+   # this setting can be done at the console, via
+   #   weighflow_cli login
+   # or through in code if using the gem within your own code by supplying
+   # a block and passing in the credientials.
+   #
    def self.configuration
     if block_given?
       configuration = Configuration.new
@@ -38,24 +46,45 @@ module WeighflowCli
    end
  
   
+   ##
+   # Creates an instance of the API client lib for direct access to the api
   def self.client    
     @client ||= Client.new(configuration)  
   end
  
 
+  ## 
+  # Pull down the orders and store in the local repository data path
+  # * This is used to management order changes
+  # 
   def self.pull
     WeighflowCli::OrderHandler.pull
   end
 
 
+  ##
+  # Find a specific order based on the +external_id+ given withing the orders
+  # + Helps to pull order details when needed.
   def self.find_order(external_id)
     WeighflowCli::OrderHandler.find_order(external_id)
   end
 
 
-  def self.list
-    WeighflowCli::OrderHandler.list
+  def self.list(indexes_only: false)
+    WeighflowCli::OrderHandler.list(indexes_only: indexes_only)
+  end
+
+  def self.weights
+    client.weights
+  end
+
+
+  def self.create_weight(params: {})
+    client.create_weight(params: params)
   end
   
+  def self.void_weight(weight_id, reason)
+    client.void_weight(weight_id, reason)
+  end
  
 end

data/lib/weighflow_cli/cli.rb

@@ -1,15 +1,129 @@
-module WeighflowCli 
+ require 'byebug'
+ 
+ module WeighflowCli 
+
+  class Weights < Thor
+    include Rendering
+
+    desc 'from_index [INDEX ID]', 'create weight from index'
+    #option :index, required: true, banner: 'ie. CommodityOrder-T-I-002-3340455-01'
+    option :gross, aliases: '-g', type: :numeric, required: true
+    option :tare, aliases: '-t', type: :numeric, required: true
+    option :certificate, aliases: '-c', required: true
+    def from_index(index_id)
+      raise 'index_id required' unless index_id
+      index = WeighflowCli.find_order(index_id)
+      raise 'index not found for id' unless index && index.data
+      #
+      # parse external id parts
+      order_type, transport, io, location, order_num, lin =  index.data[:external_unique_id].to_s.split('-')
+      #
+      # correct for diff in type between order and weight processor
+      order_type = 'Inventory' if order_type == 'BulkInventory'
+      #
+      weight_params = {
+        io: index.data[:i_o],
+        order_id: index.data[:order_id],
+        order_type: order_type,
+        gross_weight: options[:gross].to_i,
+        tare_weight: options[:tare].to_i,
+        weighed_at: Time.now.round,
+        certificate_number: options[:certificate].to_s
+      }
+
+      options_renderer(WeighflowCli.create_weight(params: weight_params), options) 
+    end
+  
+
+    desc 'template [INDEX_ID]', 'create weight template'
+    def template(index_id)
+      aise 'index_id required' unless index_id
+      index = WeighflowCli.find_order(index_id)
+      raise 'index not found for id' unless index && index.data
+       #
+      # parse external id parts
+      order_type, transport, io, location, order_num, lin =  index.data[:external_unique_id].to_s.split('-')
+      #
+      # correct for diff in type between order and weight processor
+      order_type = 'Inventory' if order_type == 'BulkInventory'
+      #
+      weight_params = {
+        io: index.data[:i_o],
+        order_id: index.data[:order_id],
+        order_type: order_type,
+        gross_weight: 0,
+        tare_weight: 0,
+        weighed_at: Time.now.round,
+        certificate_number: "{cert number}"
+      }
+      options_renderer(weight_params, options) 
+    end
+
+    
+    desc 'list', 'List weights within the last 24 hours'    
+    def list
+      options_renderer(WeighflowCli.weights, options) 
+    end
+
+
+
+    desc 'create', 'Create a weight given an order'   
+    long_desc <<~DESC
+
+      weighflow_cli --file weight.json
+
+      This file should contain a minimum of :
+
+       { 
+         order_type: "Commodity", 
+        io: "O", 
+        order_id: "{integer}", 
+        gross_weight: "75000", 
+        tare_weight: "25444", 
+        weighed_at: "2021-02-26 10:15:41 am", 
+        release_number: "", 
+        truck_license_number: "", 
+        trailer1_license_number: "", 
+        trailer2_license_number: "", 
+        truck_number: "", 
+        driver_name: "", 
+        driver_number: "" 
+      }
+    
+    --
+    DESC
+    option :file, aliases: '-f',  required: true, banner: '[File name] json format'
+    def create 
+      weight_params = JSON.parse(File.read(options[:file]), symbolize_names: true)
+      puts weight_params
+       
+      options_renderer(WeighflowCli.create_weight(params: weight_params), options) 
+      #options_renderer(options, options) 
+    end
+
+
+    desc 'void', 'Voided a weight within 24 hours'
+    option :weight_id, required: true
+    option :reason, required: true
+    def void 
+      options_renderer(WeighflowCli.void_weight(options[:weight_id], options[:reason]), options) 
+    end
+    
+  end
+
   class Cli < Thor
     include Rendering
     package_name "WeighflowCli"
+    class_option :yaml, type: :boolean
  
+    desc 'weights', 'weights commands'
+    subcommand 'weights', Weights
 
     def self.exit_on_failure?
       false
     end
 
-    desc "status", "Get system status"
-    method_options yaml: :boolean
+    desc "status", "Get system status"   
     def status 
       options_renderer(WeighflowCli.client.status, options)
     end
@@ -29,8 +143,7 @@ module WeighflowCli
 
 
 
-    desc "pull", "Pull Orders from Weighflow"
-    method_options yaml: :boolean
+    desc "pull", "Pull Orders from Weighflow"     
     def pull 
       options_renderer(WeighflowCli.pull, options)
     end
@@ -38,18 +151,26 @@ module WeighflowCli
 
 
 
-    desc 'list', "List currently pulled orders"
-    method_options yaml: :boolean
+    desc 'list', "List currently pulled orders"     
     def list
       options_renderer(WeighflowCli.list, options) 
     end
 
+    desc 'indexes', "List currently pulled order indexes"     
+    def indexes
+      options_renderer(WeighflowCli.list(indexes_only: true), options) 
+    end
 
 
-    
 
-    desc 'find_order', 'Find order details'
-    method_options yaml: :boolean
+
+   
+
+
+
+  
+
+    desc 'find_order', 'Find order details'    
     def find_order(external_id)             
       if index = WeighflowCli.find_order(external_id) 
         options_renderer(index.data, options)

data/lib/weighflow_cli/client.rb

@@ -15,9 +15,23 @@ module WeighflowCli
 
     
     def status
-      response = self.class.get('/')    
-      render_error(response) unless response.success?        
-      JSON.parse(response.body, symbolize_names: true)
+      response = self.class.get('/')        
+      render_json(response)
+    end
+
+    def create_weight(params: {})
+      response = self.class.post('/weights', body: params)    
+      render_json(response)
+    end
+
+    def void_weight(weight_id, reason)
+      response = self.class.delete("/weights/#{weight_id}", body: { reason: reason })    
+      render_json(response)
+    end
+
+    def weights
+      response = self.class.get('/weights')    
+      render_json(response)
     end
 
 
@@ -42,15 +56,19 @@ module WeighflowCli
     private
 
     def find_orders(selection: 'OC')
-      response = self.class.get('/orders', query: { s: selection })
-      render_error(response) unless response.success?     
-      JSON.parse(response.body, symbolize_names: true)
+      response = self.class.get('/orders', query: { s: selection })    
+      render_json(response)
     end
  
     def render_error(response)
       raise Error, "Problem accessing Weighflow API #{response.code} : #{response.body}" 
     end
 
+    def render_json(response)
+      render_error(response) unless response.success?  
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
   end
 
 end

data/lib/weighflow_cli/order_handler.rb

@@ -39,11 +39,15 @@ module WeighflowCli
 
     #
     # List all orders currently in stored repository
-    def self.list
+    def self.list(indexes_only: false)
       result = []
       finder = Finder.new
       finder.for_each_index do |index|             
-        result << index.data
+        if indexes_only
+          result << index.index
+        else
+          result << index.data
+        end
       end
       result
     end

data/lib/weighflow_cli/version.rb

@@ -3,7 +3,7 @@
 
 
 module WeighflowCli
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weighflow_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Bruce Martin