weighflow_cli 0.2.3 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b16083d957ff3cfad0f8b7a0adbdf38837e3f2ec19b47402c24d8f4fba7f064
-  data.tar.gz: 95078a43257981ce4f2599a349d107620c1c0b35fa14fcabdb189b4c635a587e
+  metadata.gz: d2f3ed43fcfecb4a905c2e58e8e38920002f9267dc151917472bdaca2abad173
+  data.tar.gz: 0443ce04de39d02bb39dca8fa908d4dc854c014d359b2b9225e2865511bde5f8
 SHA512:
-  metadata.gz: 99a11f91ee22093061ab6e8bec309d8aebb3e5450d322a8d3ae688d50ec2caec99d41168fd50d9befbf70a994430eff81303525ead01c03543e1de9230ebffcf
-  data.tar.gz: a2e6813efc1754aba5b92d70de63ff2e3b785d1bed7bd63c94af8e086d5cd1ab0ec258e0b0d8e6e82c87ecddf30b5770922ed501be507c4edd89dab1169c9a71
+  metadata.gz: 0bf5120b6de638145c148e6ac3b695f1fde406246c04a006933a4b3a9d19a7ac1213a9e7cd12517ec9511f39f1043b02d8222fdcb1931663da3323af7958d1e9
+  data.tar.gz: 1bf4768ac5f4e8df1845bea9ecb88d9b9dfb82aa15dc35714bc268a0e4213363fea9a4061b9185e5758a76e4e4f85587d8d45a6e5dab26e7e353fff91e9d907d

data/.byebug_history

@@ -1,4 +1,31 @@
 c
+ap result.first.keys
+ap keys
+q
+c
+uri
+uri.port = 80
+uri.methods
+ap uri
+c
+result.class
+ap result
+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/.gitignore

@@ -7,6 +7,8 @@
 /spec/reports/
 /tmp/
 /.data/*
+/spec/data
+
 # rspec failure tracking
 .rspec_status
 .secret.key

data/Gemfile

@@ -10,4 +10,6 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem 'awesome_print'
 gem 'byebug'
-gem 'gem-release'
+gem 'gem-release'
+gem 'vcr'
+gem 'webmock'

data/Gemfile.lock

@@ -1,25 +1,32 @@
 PATH
   remote: .
   specs:
-    weighflow_cli (0.2.2)
+    weighflow_cli (0.2.7)
       httparty
       thor (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     awesome_print (1.8.0)
     byebug (11.1.3)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
     gem-release (2.2.1)
+    hashdiff (1.0.1)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.1104)
+    mime-types-data (3.2021.0225)
     multi_xml (0.6.0)
+    public_suffix (4.0.6)
     rake (13.0.3)
+    rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -34,6 +41,11 @@ GEM
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
     thor (1.1.0)
+    vcr (6.0.0)
+    webmock (3.12.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -45,6 +57,8 @@ DEPENDENCIES
   gem-release
   rake (~> 13.0)
   rspec (~> 3.0)
+  vcr
+  webmock
   weighflow_cli!
 
 BUNDLED WITH

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/exe/weighflow_cli

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
 require "weighflow_cli"
- 
+
+
 WeighflowCli::Cli.start(ARGV)

data/lib/weighflow_cli.rb

@@ -6,6 +6,7 @@ require 'httparty'
 require_relative "weighflow_cli/version"
 require_relative 'weighflow_cli/rendering'
 require_relative 'weighflow_cli/client'
+#require_relative 'weighflow_cli/cli_weights'
 require_relative 'weighflow_cli/cli'
 require_relative 'weighflow_cli/credentials'
 require_relative 'weighflow_cli/order_handler'
@@ -15,18 +16,35 @@ module WeighflowCli
 
   class Error < StandardError; end
   # 
-  _ROOT_PATH = File.expand_path('../../',__FILE__).freeze
+  _ROOT_PATH = File.expand_path('~/.weighflow_cli').freeze
   #
-  # Provide an orderride to relocate data directory
-  DATA_PATH = ENV['WEIGHFLOW_CLI_PATH'] || File.join(_ROOT_PATH, '.data')
+  Dir.mkdir(_ROOT_PATH) unless Dir.exists?(_ROOT_PATH)
   #
-  #
-  # ensure data path
-  Dir.mkdir(DATA_PATH) unless Dir.exists?(DATA_PATH)
+   
+  # Provide an override to relocate data directory
+  def self.data_path
+    return @data_path if defined?(@data_path)
+    @data_path ||= ENV.fetch('WEIGHFLOW_CLI_PATH') { File.join(_ROOT_PATH, 'data') }
+    ensure_data_path
+    @data_path
+  end
+
+  ##
+  # Ensure data path
+  def self.ensure_data_path
+    Dir.mkdir(data_path) unless Dir.exists?(data_path)
+  end
    #
   
    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
@@ -37,24 +55,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,23 +1,31 @@
-module WeighflowCli 
+ require_relative 'cli_weights'
+ 
+ module WeighflowCli 
+
+ 
   class Cli < Thor
     include Rendering
+   
+
     package_name "WeighflowCli"
+    class_option :yaml, type: :boolean
  
+    desc 'weights', 'weights commands'
+    subcommand 'weights', CliWeights
 
     def self.exit_on_failure?
       false
     end
 
-    desc "status", "Get system status"
-    method_options yaml: :boolean
+    desc "status", "Get system status"   
     def status 
-      WeighflowCli.options_renderer(WeighflowCli.client.status, options)
+      options_renderer(WeighflowCli.client.status, options)
     end
 
 
     desc 'data_path', "Current data path"
     def data_path
-      puts DATA_PATH
+      puts WeighflowCli.data_path
     end
 
 
@@ -25,31 +33,26 @@ module WeighflowCli
     def login
       Credentials.login      
     end
+ 
 
-
-
-
-    desc "pull", "Pull Orders from Weighflow"
-    method_options yaml: :boolean
+    desc "pull", "Pull Orders from Weighflow"     
     def pull 
       options_renderer(WeighflowCli.pull, options)
     end
- 
-
-
+  
 
-    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/cli_weights.rb

@@ -0,0 +1,111 @@
+
+module WeighflowCli 
+  class CliWeights < 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
+end

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
@@ -60,7 +64,7 @@ module WeighflowCli
       #
       # Data index file name
       def index_file_name 
-        @index_file_name ||= File.join(DATA_PATH, 'orders_index_cache')
+        @index_file_name ||= File.join(WeighflowCli.data_path, 'orders_index_cache')
       end
         
 
@@ -81,7 +85,7 @@ module WeighflowCli
       #
       # Build the file name from the checksum
       def build_detail_file_name(order)
-        File.join(DATA_PATH, 'order_' + create_checksum(order) + '.json')
+        File.join(WeighflowCli.data_path, 'order_' + create_checksum(order) + '.json')
       end
  
 

data/lib/weighflow_cli/rendering.rb

@@ -4,7 +4,7 @@ module WeighflowCli
       if options[:yaml]
         puts result.to_yaml
       else
-        puts result.to_json     
+        puts JSON.pretty_generate(result)
       end
     end
   end 

data/lib/weighflow_cli/version.rb

@@ -3,7 +3,7 @@
 
 
 module WeighflowCli
-  VERSION = "0.2.3"
+  VERSION = "0.2.8"
 
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weighflow_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.8
 platform: ruby
 authors:
 - Bruce Martin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -60,6 +60,7 @@ files:
 - exe/weighflow_cli
 - lib/weighflow_cli.rb
 - lib/weighflow_cli/cli.rb
+- lib/weighflow_cli/cli_weights.rb
 - lib/weighflow_cli/client.rb
 - lib/weighflow_cli/credentials.rb
 - lib/weighflow_cli/order_handler.rb