shopify-report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05e8c968d672dc3bdde08d88dbfe6514bdb4403d
+  data.tar.gz: e6bd122d8b63b14f2fd807e32ff4eb168a3d6287
+SHA512:
+  metadata.gz: a6bee474aada73eeed761842a18c293f817c82dd71591dc42fadc4f38e877072f9a471f35cb87c0bedf08c95e88bf469504946c4af12f27632a6b1e1fabb16cf
+  data.tar.gz: 256867539f30390e76d03fe0038832048dd9aa17772eceb193231f5637bfcaac3bb0ce9683c6d832da3759f1fcabf0ebf032c78e5c5d510cd3020f85eafe91af

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Dhurba Baral
+
+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,42 @@
+# Shopify
+Fetch data from shopify which are not available through API call
+
+## Features
+* Read any data from Shopify. It doesn't use shopify API.
+* You can connect to multiple shops in the same application.
+* Requires `domain`, `login` and `password` to fetch data.
+
+## Examples
+```
+shop = ShopifyScrape.new('domain', 'username', 'password')
+date_min = 1.month.ago; date_max = Time.zone.now
+payout_report = shop.payout_report(date_min, date_max) # get payout reports
+sales_report = shop.sales_report(date_min, date_max) # get sales report
+shopify_url = shop.shopify_url # shopify url
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shopify', :git => 'git://github.com/dhurba87/shopify.git'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+Guidelines to follow:
+
+* Fork the repo
+* Create your feature branch (git checkout -b my-new-feature)
+* Make sure you have some tests, and they pass!(bundle exec rake)
+* Commit your changes(git commit -am 'Add some feature')
+* Push to the branch( git push origin my-new-feature)
+* Create new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Shopify'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/shopify.rb

@@ -0,0 +1,5 @@
+require 'shopify/captcha_exception'
+require 'shopify/shopify_scrape'
+
+module Shopify
+end

data/lib/shopify/captcha_exception.rb

@@ -0,0 +1,5 @@
+class CaptchaException < StandardError
+  def initialize(msg = 'Captcha mismatch')
+    super
+  end
+end

data/lib/shopify/shopify_scrape.rb

@@ -0,0 +1,116 @@
+require 'net/http'
+require 'csv'
+
+class ShopifyScrape
+  def initialize(domain, username, password)
+    @domain = domain
+    @username = username
+    @password = password
+
+    @cookie = login
+  end
+
+  def shopify_url
+    "https://#{@domain}.myshopify.com"
+  end
+
+  def payout_report(date_min=Time.zone.now.beginning_of_month, date_max=Time.zone.now.end_of_month)
+    url = URI("#{shopify_url}/admin/payments/payouts.json?date_min=#{date_min}&date_max=#{date_max}")
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request1 = Net::HTTP::Get.new(url)
+    request1["content-type"] = 'application/x-www-form-urlencoded'
+    request1["cache-control"] = 'no-cache'
+    request1["cookie"] = @cookie
+
+    response = http.request(request1)
+
+    raise Exception, parse_error(response.body) if response.code.to_i >= 400
+    JSON.parse(response.body)
+  end
+
+  def sales_report(date_min=Time.zone.now.beginning_of_month, date_max=Time.zone.now.end_of_month)
+    url = URI("https://analytics.shopify.com/query?q=SHOW%20orders%20AS%20%22orders%22%2C%20gross_sales%20AS%20%22gross_sales%22%2C%20discounts%20AS%20%22discounts%22%2C%20returns%20AS%20%22returns%22%2C%20net_sales%20AS%20%22net_sales%22%2C%20shipping%20AS%20%22shipping%22%2C%20taxes%20AS%20%22taxes%22%2C%20total_sales%20AS%20%22total_sales%22%20OVER%20month%20AS%20%22month%22%20FROM%20sales%20SINCE%20-11m%20UNTIL%20today%20ORDER%20BY%20%22month%22%20ASC&format=csv&source=shopify-summary&token=#{get_token}&beta=true&handle=sales_#{date_min}_#{date_max}")
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request = Net::HTTP::Get.new(url)
+    request["cookie"] = @cookie
+    request["cache-control"] = 'no-cache'
+
+    response = http.request(request)
+
+    raise Exception, parse_error(response.body) if response.code.to_i >= 400
+
+    csv_arr = CSV.parse(response.read_body)
+    keys = csv_arr.shift
+    arr_of_object = csv_arr.map {|a| Hash[keys.zip(a)]}
+
+    total_shipping = 0
+    total_taxes = 0
+    arr_of_object.each do |obj|
+      total_shipping = total_shipping + obj['shipping'].to_f
+      total_taxes = total_taxes + obj['taxes'].to_f
+    end
+
+    {shipping: total_shipping, taxes: total_taxes}
+  end
+
+  private
+
+  def login
+    login_url = "#{shopify_url}/admin/auth/login"
+
+    url = URI(login_url)
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request = Net::HTTP::Post.new(url)
+    request["content-type"] = 'application/x-www-form-urlencoded'
+    request["cache-control"] = 'no-cache'
+    request.body = "login=#{@username}&password=#{@password}"
+
+    response = http.request(request)
+
+    # Check for invalid username/password
+    validation_error_message = Nokogiri::HTML(response.body).css('span.validation-error__message')
+
+    raise validation_error_message.text if validation_error_message.length > 0
+    raise 'Domain not found' if response.code.to_i == 404
+    raise CaptchaException, 'Captcha displayed while logging in' unless response.code.to_i == 302
+
+    # Return cookie
+    response['set-cookie']
+  end
+
+  def get_token
+    url = URI("#{shopify_url}/admin/reportify/token.json")
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request = Net::HTTP::Get.new(url)
+    request["cookie"] = @cookie
+    request["cache-control"] = 'no-cache'
+
+    response = http.request(request)
+    JSON.parse(response.body)['token']
+  end
+
+  def parse_error(response_body)
+    begin
+      JSON.parse(response_body)['message']
+    rescue JSON::ParserError
+      # todo::Use nokogiri to parse error from html page
+      'Error occurred.'
+    end
+  end
+
+end

data/lib/shopify/version.rb

@@ -0,0 +1,3 @@
+module Shopify
+  VERSION = '0.1.0'
+end

data/lib/tasks/shopify_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :shopify do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: shopify-report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhurba Baral
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+description: Shopify reports which are not available through API
+email:
+- dhurba87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/shopify.rb
+- lib/shopify/captcha_exception.rb
+- lib/shopify/shopify_scrape.rb
+- lib/shopify/version.rb
+- lib/tasks/shopify_tasks.rake
+homepage: https://github.com/dhurba87/shopify
+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.6.14
+signing_key: 
+specification_version: 4
+summary: fetch shopify payout report and sales report
+test_files: []