whiplash-batches-api 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f41cb18432683142210262aa20c381ac90dcaecd78cad6d4dc2956782854aa29
+  data.tar.gz: 91380399218da67b887f547467dbb67eb9921dd53afb2019fba6b750ef2b87de
+SHA512:
+  metadata.gz: 957010d5543621a1377f1a8ddf51c260b278443a3bd31cd3e0b7becc5658a5f0615b36abdcf788e8e0d6fb3974f42db2964c12cd9c4ce9a104352c9a1fc9e0df
+  data.tar.gz: 668b5b8dfb4608922f2a476b91468a59879a2e7d9a2c0508d55b688653d616f94f42aaacf6443ddaa84087d00b35ac4fdc5b131134a9050ac8b1f3f87048c03d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.env
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/html/
+/pkg/
+/spec/reports/
+/tmp/
+/test.rb
+/.rake_t_cache
+/Gemfile.lock
+*.gem
+.vscode

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+  
+gemspec  

data/README.md

@@ -0,0 +1,100 @@
+# Whiplash Batches Api
+
+Whiplash Batches Api
+## Get Started
+```ruby
+gem 'whiplash-batches-api', github: 'wqsaali/whiplash-batches-api'
+```
+create `config/initializer/whiplash_initializer.rb` file
+```ruby
+Whiplash.configure do |config|
+  config.whiplash_email = WHIPLASH_EMAIL
+  config.whiplash_password = WHIPLASH_PASSWORD
+  config.whiplash_base_url = 'https://www.getwhiplash.com'
+end
+```
+## Usage
+``` ruby
+handler = Whiplash::Batches::Api.new
+```
+### GET BATCHES
+``` ruby
+handler.batches
+```
+response is 
+``` json
+[{"batch": "437737",
+  "to_pack": "2",
+  "to_label": "2",
+  "total_items": "51",
+  "printed": "Mar 01, 2019  2:20PM",
+  "pre_pack_buy": "",
+  "assigned": "Start",
+  "started": "",
+  "stopped": "",
+  "min": "",
+  "incidents": "",
+  "order_ids": ["7511027", "7515574"],
+  "page": 1
+  },
+  {"batch": "437732",
+  "to_pack": "2",
+  "to_label": "2",
+  "total_items": "51",
+  "printed": "Mar 01, 2019  2:20PM",
+  "pre_pack_buy": "",
+  "assigned": "Start",
+  "started": "",
+  "stopped": "",
+  "min": "",
+  "incidents": "",
+  "order_ids": ["7511021", "7515575"],
+  "page": 1
+  }
+]
+```
+
+You can also add page number and ignore_list
+1. if page number is given we fetch from given page number to end (ie if total pages we 10 and given page number is 7 then we return all batches from 7 to 10 pages)
+2. If you want to ignore some batches add array of batch ids
+``` ruby
+  handler.batches(1, ["437737"])
+```
+It returns 
+``` json
+[
+  {"batch": "437732",
+  "to_pack": "2",
+  "to_label": "2",
+  "total_items": "51",
+  "printed": "Mar 01, 2019  2:20PM",
+  "pre_pack_buy": "",
+  "assigned": "Start",
+  "started": "",
+  "stopped": "",
+  "min": "",
+  "incidents": "",
+  "order_ids": ["7511021", "7515575"],
+  "page": 1
+  }
+]
+```
+
+### GET ORDERS
+``` ruby
+  handler.orders(437732)
+```
+it returns
+``` json
+["7511021", "7515575"]
+```
+
+# License
+
+Copyright (c) 2019 Waqas Ali
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+desc "Build the gem"
+task :build do
+  system "gem build whiplash-batches-api.gemspec"
+end
+
+desc "Build and release the gem"
+task :release => :build do
+  system "gem push whiplash-batches-api-#{Whiplash::Batches::VERSION}.gem"
+end

data/lib/whiplash-batches-api.rb

@@ -0,0 +1,17 @@
+require "whiplash/batches/version"
+require "whiplash/batches/api"
+
+module Whiplash
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :whiplash_email, :whiplash_password, :whiplash_base_url
+  end
+end

data/lib/whiplash/batches/api.rb

@@ -0,0 +1,80 @@
+require 'mechanize'
+class Whiplash::Batches::Api
+  attr_reader :agent, :current_page, :whiplash_base_url, :order_current_page
+
+  def initialize
+    if Whiplash.configuration.present?
+      @username = Whiplash.configuration.whiplash_email
+      @password = Whiplash.configuration.whiplash_password
+      @whiplash_base_url = Whiplash.configuration.whiplash_base_url
+    end
+    check_confuration_variables
+    @agent = Mechanize.new
+    login
+  end
+
+  def batches(page = 1, ignore_ids = [])
+    results = []
+    ignore_ids.map!(&:to_s) # convert to ids of string
+    @current_page = agent.get("#{@whiplash_base_url}/order_batches?page=#{page}")
+    results << build_batch_hash(current_page, ignore_ids, page)
+    page += 1 # page is scrapped already
+    loop do
+      next_page = current_page.links.find{ |l| l.href.to_s.include?("/order_batches?page=#{page}") }
+      if next_page.present?
+        batch_page = next_page.click
+        results << build_batch_hash(batch_page, ignore_ids, page)
+        page += 1
+      else
+        break
+      end
+    end
+    
+    results.flatten
+  end
+
+  def orders(batch_id = nil)
+    return [] if batch_id.nil?
+    @order_current_page = agent.get("#{@whiplash_base_url}/order_batches/#{batch_id}")
+    orders = order_current_page.links.select { |l| l.href.to_s.match(/\/orders\/.[0-9]+/) }
+    orders.map{ |l| l.text.split('-').first }
+  end
+
+  def login
+    page = agent.get("#{@whiplash_base_url}/login")
+    @current_page = page.form_with(:id => 'new_user') do |form|
+      form.field_with(name: 'user[email]').value = @username
+      form.field_with(name: 'user[password]').value = @password
+    end.submit
+    if current_page.title == "Log In"
+      raise "Credentials: Login credentials invalid!"
+    end
+  end
+
+  private
+
+  def check_confuration_variables
+    raise 'whiplash_email is not configured in initializer' if @username.nil?
+    raise 'whiplash_password is not configured in initializer' if @password.nil?
+    raise 'whiplash_base_url is not configured in initializer' if @whiplash_base_url.nil?
+  end
+
+  def build_batch_hash(current_page, ignore_ids, page)
+    records = []
+    table = current_page.search('table#order-batches')[0]
+    if table.present?
+      headers = table.search('thead tr th').map{ |th| th.text.downcase.parameterize.underscore }
+      table.search('tbody tr').each do |tr|
+        next if ignore_ids.include?(tr.at('td a').text.strip)
+        hash = {}
+        tr.elements.each_with_index do |td, index|
+          hash[headers[index]] = td.at('a').present? ? td.at('a').text.strip : td.text.strip
+        end
+        hash['order_ids'] = orders(hash['batch']) 
+        hash['page'] = page
+        records << hash
+      end
+      records
+    end
+  end
+end

data/lib/whiplash/batches/version.rb

@@ -0,0 +1,5 @@
+module Whiplash
+  module Batches
+    VERSION = "1.0".freeze
+  end
+end

data/whiplash-batches-api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/whiplash/batches/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_runtime_dependency 'mechanize', '~> 2.7'
+  
+
+  # gem.add_development_dependency 'rspec', '~> 2.7'
+  # gem.add_development_dependency 'rack-test'
+  # gem.add_development_dependency 'webmock'
+  # gem.add_development_dependency 'simplecov'
+
+  gem.authors       = ["Waqas Ali"]
+  gem.email         = ["wqsaali@gmail.com"]
+  gem.description   = %q{Enable Whiplash batches api with email/password}
+  gem.summary       = %q{Enable Whiplash batches api with emai/password}
+  gem.homepage      = "https://github.com/wqsaali/whiplash-batches-api"
+  gem.license       = "GPL-3.0"
+
+  gem.files         = `git ls-files`.split("\n")
+  # gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "whiplash-batches-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Whiplash::Batches::VERSION
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: whiplash-batches-api
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Waqas Ali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Enable Whiplash batches api with email/password
+email:
+- wqsaali@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/whiplash-batches-api.rb
+- lib/whiplash/batches/api.rb
+- lib/whiplash/batches/version.rb
+- whiplash-batches-api.gemspec
+homepage: https://github.com/wqsaali/whiplash-batches-api
+licenses:
+- GPL-3.0
+metadata: {}
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Enable Whiplash batches api with emai/password
+test_files: []