shopkeep_reports 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dd1f8a99699ff380b7c06bcb7aa2f2734c09e7e
+  data.tar.gz: 3da7a4f911d40da5a6a27963a2d60aa0da16d886
+SHA512:
+  metadata.gz: 656e7facf7b193c31a6f3ece840362aa0d41bdb22407c2cb04f4c432be8dddcb1049662d4241182311fe8f090322728a1c44e421304e3c9b46638ccb699b2526
+  data.tar.gz: f6ebbe962864a929dec07b726674279cc33f366ff11b51ea97af579c256998cf2b416d6ac34010425bf6e90c803879e0a57ffb890bc5158fa02eb61beb7c85e3

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shopkeep_reports.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kunwar Aditya Raghuwanshi
+
+MIT License
+
+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/README.md

@@ -0,0 +1,67 @@
+# ShopkeepReports
+
+Gem for downloading shopkeep reports via mechanize
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shopkeep_reports'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shopkeep_reports
+
+## Usage
+
+### Initialize with ENV variables set
+
+```ruby
+# config/initializers/shopekeep.rb
+# ENV['SHOPKEEP_EMAIL'] & ENV['SHOPKEEP_PASSWORD'] & ENV['SHOPKEEP_ACCOUNT'] should be set
+ShopkeepReports.configure do
+end
+```
+
+else
+
+```ruby
+ShopkeepReports.configure do |c|
+  c.email = 'me@example.com'
+  c.password = 'my_password'
+  c.account = 'awesomecompany'
+end
+```
+
+### Use
+
+Provided functions return a file name stored in your root/tmp directory
+
+```ruby
+d = ShopkeepReports::Downloader.new
+d.customer_report
+
+d.sales_report(Time.now - 1.month, Time.now)
+# OR
+d.sales_report
+
+# Similarly start and end date optional parameters for:
+d.sold_items_report
+d.returns_report
+d.returned_items_report
+
+d.download_inventory
+d.download_transactions(start_date: Time.now - 1.week, end_date: Time.now, detailed: true, tenders: false)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/shopkeep_reports/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/shopkeep_reports/client.rb

@@ -0,0 +1,95 @@
+require 'singleton'
+require 'mechanize'
+require 'open-uri'
+
+module ShopkeepReports
+  class Client
+    include Singleton
+
+    @@agent = false
+    @@cookie_jar = false
+    @@token = false
+    attr_accessor :agent, :cookie_jar, :token
+
+    def self.instance
+      @@instance ||= new
+    end
+
+    def authorize(params = {})
+      return @@agent if @@agent
+      @username = configuration.email
+      @password = configuration.password
+      login
+    end
+
+    def download_report(report_link, type = 'get', start_date = nil, end_date = nil)
+      new_agent = Mechanize.new
+      new_agent.cookie_jar = @@cookie_jar
+      case type
+      when 'get'
+        new_agent.get(report_link)
+        if !start_date.blank? and !end_date.blank?
+          new_agent.page.forms.first.set_fields({
+            'start_date' => start_date.to_s,
+            'end_date' => end_date.to_s
+          })
+        end
+        new_agent.page.forms.first.submit
+      when 'post'
+        new_agent.post(report_link, { 'authenticity_token' => @@token })
+      end
+      download_link = new_agent.page.link_with(:text => 'Download')
+      if download_link.blank?
+        file_uri = new_agent.page.forms.first.submit.uri
+      else
+        file_uri = download_link.uri
+      end
+      file_name = File.join(ShopkeepReports.root, 'tmp', (file_uri.to_s.split('.csv').first.split('/').last + '.csv'))
+      File.open(file_name, "wb") do |file|
+        file_uri.open do |uri|
+          file.write(uri.read)
+        end
+      end
+      file_name
+    rescue Exception => e
+      reset
+      raise ShopkeepException, "#{e.message}"
+    end
+
+    def download_report_link(report_link)
+      new_agent = Mechanize.new
+      new_agent.cookie_jar = @@cookie_jar
+      download = new_agent.get(report_link)
+      file_body = download.body
+      file_name = File.join(ShopkeepReports.root, 'tmp', download.filename)
+      File.open(file_name, "wb") do |file|
+        file.write(file_body)
+      end
+      file_name
+    rescue Exception => e
+      reset
+      raise ShopkeepException, "#{e.message}"
+    end
+
+    private
+    def configuration
+      ShopkeepReports.configuration
+    end
+
+    def login
+      agent = Mechanize.new
+      agent.get(configuration.uri('/login'))
+      form = agent.page.forms.first
+      form.login = @username
+      form.password = @password
+      form.submit
+      @@cookie_jar = agent.cookie_jar
+      @@token = agent.page.at('meta[@name="csrf-token"]')['content']
+      @@agent = agent
+    end
+
+    def reset
+      @@agent = false
+    end
+  end
+end

data/lib/shopkeep_reports/configuration.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+
+module ShopkeepReports
+  class Configuration
+    include Singleton
+
+    attr_accessor :email, :password, :account
+
+    def self.instance
+      @@instance ||= new
+    end
+
+    def init(args = {})
+      @email = default_email
+      @password = default_password
+      @account = default_account
+      args.each_pair do |option, value|
+        self.send("#{option}=", value)
+      end
+    end
+
+    def valid?
+      result = true
+      [:email, :password, :account].each do |value|
+        result = false if self.send(value).blank?
+      end
+      result
+    end
+
+    def uri(path)
+      "https://" + @account + ".shopkeepapp.com" + path
+    end
+
+    private
+    def default_email
+      ENV['SHOPKEEP_EMAIL']
+    end
+
+    def default_password
+      ENV['SHOPKEEP_PASSWORD']
+    end
+
+    def default_account
+      ENV['SHOPKEEP_ACCOUNT']
+    end
+  end
+end

data/lib/shopkeep_reports/downloader.rb

@@ -0,0 +1,57 @@
+module ShopkeepReports
+  class Downloader
+    def initialize
+      raise ShopkeepException, "Configuration is invalid" unless Configuration.instance.valid?
+    end
+
+    def customer_report
+      Client.instance.authorize
+      Client.instance.download_report(configuration.uri('/customers/create_export'), 'post')
+    end
+
+    def sales_report(start_date = nil, end_date = nil)
+      Client.instance.authorize
+      Client.instance.download_report(configuration.uri('/exports/sales/new'), 'get', start_date, end_date)
+    end
+
+    def sold_items_report(start_date = nil, end_date = nil)
+      Client.instance.authorize
+      Client.instance.download_report(configuration.uri('/sold_items/new_export'), 'get', start_date, end_date)
+    end
+
+    def returns_report(start_date = nil, end_date = nil)
+      Client.instance.authorize
+      Client.instance.download_report(configuration.uri('/returns/new_export'), 'get', start_date, end_date)
+    end
+
+    def returned_items_report(start_date = nil, end_date = nil)
+      Client.instance.authorize
+      Client.instance.download_report(configuration.uri('/returned_items/new_export'), 'get', start_date, end_date)
+    end
+
+    def download_inventory
+      Client.instance.authorize
+      Client.instance.download_report_link(configuration.uri('/stock_items_exports/export_bulk_inventory'))
+    end
+
+    def download_transactions(args = {})
+      start_date = args.fetch(:start_at, Time.now.beginning_of_day)
+      end_date = args.fetch(:end_date, Time.now)
+      detailed = args.fetch(:detailed, false)
+      tenders = args.fetch(:tenders, false)
+      query = {
+        start_date: start_date.strftime("%B %d %Y %I:%M %p"),
+        end_date: end_date.strftime("%B %d %Y %I:%M %p"),
+        detailed: detailed,
+        tenders: tenders
+      }
+      Client.instance.authorize
+      Client.instance.download_report_link(configuration.uri("/transactions.csv?#{query.to_query}"))
+    end
+
+    private
+    def configuration
+      ShopkeepReports.configuration
+    end
+  end
+end

data/lib/shopkeep_reports/version.rb

@@ -0,0 +1,3 @@
+module ShopkeepReports
+  VERSION = "1.0.0"
+end

data/lib/shopkeep_reports.rb

@@ -0,0 +1,23 @@
+require "active_support/all"
+require "shopkeep_reports/version"
+require "shopkeep_reports/configuration"
+require "shopkeep_reports/client"
+require "shopkeep_reports/downloader"
+
+module ShopkeepReports
+  class << self
+    attr_accessor :configuration
+  end
+
+  class ShopkeepException < StandardError; end
+
+  def self.configure
+    Configuration.instance.init
+    self.configuration ||= Configuration.instance
+    yield(configuration)
+  end
+
+  def self.root
+    File.dirname __dir__
+  end
+end

data/shopkeep_reports.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shopkeep_reports/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shopkeep_reports"
+  spec.version       = ShopkeepReports::VERSION
+  spec.authors       = ["Kunwar Aditya Raghuwanshi"]
+  spec.email         = ["adi.version1@gmail.com"]
+  spec.summary       = %q{Download Shopkeep Reports}
+  spec.description   = %q{Gem for downloading shopkeep reports via mechanize}
+  spec.homepage      = "http://github.com/kitwalker12/shopkeep_reports"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "mechanize"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'pry'
+require 'shopkeep_reports'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: shopkeep_reports
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kunwar Aditya Raghuwanshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for downloading shopkeep reports via mechanize
+email:
+- adi.version1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shopkeep_reports.rb
+- lib/shopkeep_reports/client.rb
+- lib/shopkeep_reports/configuration.rb
+- lib/shopkeep_reports/downloader.rb
+- lib/shopkeep_reports/version.rb
+- shopkeep_reports.gemspec
+- spec/spec_helper.rb
+homepage: http://github.com/kitwalker12/shopkeep_reports
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Download Shopkeep Reports
+test_files:
+- spec/spec_helper.rb