shopify_dashboard_plus 0.0.7 → 1.0.0

data/test/fixtures/vcr_cassettes/orders_no_paramaters.yml

@@ -0,0 +1,81 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<API_KEY>:<API_PWD>@<SHOP_NAME>.myshopify.com/admin/orders.json?created_at_max=<%= today %>%2023:59:59&created_at_min==<%= today %>%200:00&fields%5B%5D=billing_address&fields%5B%5D=created_at&fields%5B%5D=currency&fields%5B%5D=customer&fields%5B%5D=discount_codes&fields%5B%5D=line_items&fields%5B%5D=referring_site&fields%5B%5D=total_price&limit=250&page=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - ShopifyAPI/4.0.4 ActiveResource/4.0.0 Ruby/2.1.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 27 Jun 2015 03:02:01 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Sorting-Hat-Podid:
+      - '3'
+      X-Sorting-Hat-Shopid:
+      - '4500785'
+      X-Sorting-Hat-Podid-Cached:
+      - '1'
+      X-Sorting-Hat-Shopid-Cached:
+      - '1'
+      Vary:
+      - Accept-Encoding
+      Status:
+      - 200 OK
+      X-Xss-Protection:
+      - 1; mode=block; report=/xss-report/0a457a06-1849-408f-bc0f-57f4edc59f89?source%5Baction%5D=index&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin
+      X-Content-Type-Options:
+      - nosniff
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Shopid:
+      - '4500785'
+      X-Shardid:
+      - '3'
+      X-Shopify-Shop-Api-Call-Limit:
+      - 1/40
+      Http-X-Shopify-Shop-Api-Call-Limit:
+      - 1/40
+      X-Stats-Userid:
+      - '0'
+      X-Stats-Apiclientid:
+      - '860030'
+      X-Stats-Apipermissionid:
+      - '11578246'
+      Set-Cookie:
+      - request_method=GET; path=/
+      X-Request-Id:
+      - 0a457a06-1849-408f-bc0f-57f4edc59f89
+      P3p:
+      - CP="NOI DSP COR NID ADMa OPTa OUR NOR"
+      X-Dc:
+      - ash
+    body:
+      encoding: UTF-8
+      string: '{"orders":[{"created_at":"<%= today %>T20:06:43-04:00","currency":"CAD","referring_site":"http://thielhodkiewicz.ca/caandra","total_price":"281.37","discount_codes":[],"line_items":[{"product_id":"08314615","price":76.97,"title":"Ergonomic
+        Wooden Gloves","variant_id":"4564472289","vendor":"Jewelery","name":"Sleek
+        Concrete Car"}],"billing_address":{"address1":"9875 Bogan Grove","address2":"Suite
+        328","city":"Modestoport","country":"Canada","company":"Leannon-Veum","first_name":"Conner","last_name":"Grimes","latitude":"18.212338163213815","longitude":"70.88552439133932","phone":"300-733-7915
+        x4220","zip":"A5Q1V5","name":"ConnerGrimes"},"customer":{"id":"41185198","email":"frances@lubowitz.com","first_name":"Ephraim","last_name":"Baumbach"}}]}'
+    http_version: 
+  recorded_at: Sat, 27 Jun 2015 03:03:11 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/vcr_cassettes/orders_none.yml

@@ -0,0 +1,77 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<API_KEY>:<API_PWD>@<SHOP_NAME>.myshopify.com/admin/orders.json?created_at_max=2015-06-27%2023:59:59&created_at_min=2015-06-27%200:00&fields%5B%5D=billing_address&fields%5B%5D=created_at&fields%5B%5D=currency&fields%5B%5D=customer&fields%5B%5D=discount_codes&fields%5B%5D=line_items&fields%5B%5D=referring_site&fields%5B%5D=total_price&limit=250&page=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - ShopifyAPI/4.0.4 ActiveResource/4.0.0 Ruby/2.1.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 27 Jun 2015 05:19:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Sorting-Hat-Podid:
+      - '3'
+      X-Sorting-Hat-Shopid:
+      - '4500785'
+      X-Sorting-Hat-Podid-Cached:
+      - '0'
+      X-Sorting-Hat-Shopid-Cached:
+      - '0'
+      Vary:
+      - Accept-Encoding
+      Status:
+      - 200 OK
+      X-Xss-Protection:
+      - 1; mode=block; report=/xss-report/89d0344f-7536-411e-96ea-965119e394ff?source%5Baction%5D=index&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin
+      X-Content-Type-Options:
+      - nosniff
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Shopid:
+      - '4500785'
+      X-Shardid:
+      - '3'
+      X-Shopify-Shop-Api-Call-Limit:
+      - 1/40
+      Http-X-Shopify-Shop-Api-Call-Limit:
+      - 1/40
+      X-Stats-Userid:
+      - '0'
+      X-Stats-Apiclientid:
+      - '860030'
+      X-Stats-Apipermissionid:
+      - '11578246'
+      Set-Cookie:
+      - request_method=GET; path=/
+      X-Request-Id:
+      - 89d0344f-7536-411e-96ea-965119e394ff
+      P3p:
+      - CP="NOI DSP COR NID ADMa OPTa OUR NOR"
+      X-Dc:
+      - ash
+    body:
+      encoding: UTF-8
+      string: '{"orders":[]}'
+    http_version: 
+  recorded_at: Sat, 27 Jun 2015 05:20:33 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/vcr_cassettes/orders_to_2015-06-26.yml

@@ -0,0 +1,81 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<API_KEY>:<API_PWD>@<SHOP_NAME>.myshopify.com/admin/orders.json?created_at_max=2015-06-26%2023:59:59&created_at_min=2015-06-26%200:00&fields%5B%5D=billing_address&fields%5B%5D=created_at&fields%5B%5D=currency&fields%5B%5D=customer&fields%5B%5D=discount_codes&fields%5B%5D=line_items&fields%5B%5D=referring_site&fields%5B%5D=total_price&limit=250&page=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - ShopifyAPI/4.0.4 ActiveResource/4.0.0 Ruby/2.1.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 27 Jun 2015 03:02:01 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Sorting-Hat-Podid:
+      - '3'
+      X-Sorting-Hat-Shopid:
+      - '4500785'
+      X-Sorting-Hat-Podid-Cached:
+      - '1'
+      X-Sorting-Hat-Shopid-Cached:
+      - '1'
+      Vary:
+      - Accept-Encoding
+      Status:
+      - 200 OK
+      X-Xss-Protection:
+      - 1; mode=block; report=/xss-report/db2dd2d8-eb26-4650-8bc4-588a41b866ef?source%5Baction%5D=index&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin
+      X-Content-Type-Options:
+      - nosniff
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Shopid:
+      - '4500785'
+      X-Shardid:
+      - '3'
+      X-Shopify-Shop-Api-Call-Limit:
+      - 1/40
+      Http-X-Shopify-Shop-Api-Call-Limit:
+      - 1/40
+      X-Stats-Userid:
+      - '0'
+      X-Stats-Apiclientid:
+      - '860030'
+      X-Stats-Apipermissionid:
+      - '11578246'
+      Set-Cookie:
+      - request_method=GET; path=/
+      X-Request-Id:
+      - db2dd2d8-eb26-4650-8bc4-588a41b866ef
+      P3p:
+      - CP="NOI DSP COR NID ADMa OPTa OUR NOR"
+      X-Dc:
+      - ash
+    body:
+      encoding: UTF-8
+      string: '{"orders":[{"created_at":"2015-06-26T20:06:43-04:00","currency":"CAD","referring_site":"http://bartell.com/alvis","total_price":"281.37","discount_codes":[],"line_items":[{"product_id":"63864731","price":"95.11","title":"Gorgeous
+        Rubber Pants","variant_id":"7654546673","vendor":"Automotive","name":"Incredible
+        Cotton Gloves"}],"billing_address":{"address1":"72886 Emmanuelle Manors","address2":"Suite
+        813","city":"Connhaven","country":"Canada","company":"Collins LLC","first_name":"Chelsea","last_name":"Thiel","latitude":"69.41862661206804","longitude":"82.43290958920517","phone":"1-244-410-9707
+        x716","zip":"M1I9E7","name":"ChelseaThiel"},"customer":{"id":"29327241","email":"emmalee_goodwin@cronagottlieb.com","first_name":"Sarina","last_name":"Abshire"}}]}'
+    http_version: 
+  recorded_at: Sat, 27 Jun 2015 03:03:11 GMT
+recorded_with: VCR 2.9.3

data/test/resources/anonymizer.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Anonymizer
+
+  # Strip discount information and replace with fake data
+  def anonymize_discounts(orders)
+    discount_code_replacement = {}
+
+    orders.each_with_index do |order, index|
+      order['discount_codes'].each_with_index do |dc, inner_index|
+        next if dc.nil? || dc.empty?
+
+        old_code = order['discount_codes'][inner_index]['code']
+
+        unless discount_code_replacement[old_code]
+          discount_code_replacement[old_code] = Faker::Internet.slug
+        end
+
+        orders[index]['discount_codes'][inner_index]['code'] = discount_code_replacement[old_code]
+      end
+    end
+
+    orders
+  end
+
+  # Strip referral information and replace with fake data
+  def anonymize_referrals(orders)
+    referring_site_replacement = {}
+
+    orders.each_with_index do |order, index|
+      next if order['referring_site'].nil? || order['referring_site'].empty?
+
+      old_site = order['referring_site']
+
+      unless referring_site_replacement[old_site]
+        referring_site_replacement[old_site] = Faker::Internet.url
+      end
+
+      orders[index]['referring_site'] = referring_site_replacement[old_site]
+    end
+
+    orders
+  end
+
+  # Strip billing address informatino and replace with fake data
+  def anonymize_billing_address(orders)
+    billing_address_replacement = Hash.new { |hash, key| hash[key] = {} }
+
+    orders.each_with_index do |order, index|
+      next if order['billing_address'].nil? || order['billing_address'].empty?
+
+      old_address = order['billing_address']['address1']
+
+      if billing_address_replacement[old_address].empty?
+        billing_address_replacement[old_address]['address1'] = Faker::Address.street_address
+        billing_address_replacement[old_address]['address2'] = Faker::Address.secondary_address
+        billing_address_replacement[old_address]['city'] = Faker::Address.city
+        billing_address_replacement[old_address]['country'] = 'Canada'
+        billing_address_replacement[old_address]['company'] = Faker::Company.name
+        billing_address_replacement[old_address]['first_name'] = Faker::Name.first_name
+        billing_address_replacement[old_address]['last_name'] = Faker::Name.last_name
+        billing_address_replacement[old_address]['latitude'] = Faker::Address.latitude
+        billing_address_replacement[old_address]['longitude'] = Faker::Address.longitude
+        billing_address_replacement[old_address]['phone'] = Faker::PhoneNumber.phone_number
+        billing_address_replacement[old_address]['zip'] = Faker::Address.zip_code
+        billing_address_replacement[old_address]['name'] = billing_address_replacement[old_address]['first_name'] + billing_address_replacement[old_address]['last_name']
+      end
+
+      orders[index]['billing_address'] = billing_address_replacement[old_address]
+    end
+
+    orders
+  end
+
+  # Strip line item information and replace with fake data
+  def anonymize_line_items(orders)
+    line_items_replacement = Hash.new { |hash, key| hash[key] = {} }
+
+    orders.each_with_index do |order, index|
+      order['line_items'].each_with_index do |item, inner_index|
+        next if item.empty?
+        old_item = order['line_items'][inner_index]['product_id']
+
+        if line_items_replacement[old_item].empty?
+          line_items_replacement[old_item]['product_id'] = Faker::Number.number(8)
+          line_items_replacement[old_item]['price'] = Faker::Commerce.price.to_s
+          line_items_replacement[old_item]['title'] = Faker::Commerce.product_name
+          line_items_replacement[old_item]['variant_id'] = Faker::Number.number(10)
+          line_items_replacement[old_item]['vendor'] = Faker::Commerce.department
+          line_items_replacement[old_item]['name'] = Faker::Commerce.product_name
+        end
+
+        orders[index]['line_items'][inner_index] = line_items_replacement[old_item]
+      end
+    end
+
+    orders
+  end
+
+  # Strip customer data and replace with fake data
+  def anonymize_customers(orders)
+    customer_replacement = Hash.new { |hash, key| hash[key] = {} }
+
+    orders.each_with_index do |order, index|
+      next if order['customer'].empty?
+
+      old_customer = order['customer']['id']
+
+      if customer_replacement[old_customer].empty?
+        customer_replacement[old_customer]['id'] = Faker::Number.number(8)
+        customer_replacement[old_customer]['email'] = Faker::Internet.email
+        customer_replacement[old_customer]['first_name'] = Faker::Name.first_name
+        customer_replacement[old_customer]['last_name'] = Faker::Name.last_name
+
+        # TODO: Take billing_address parameter to fill in:
+        # customer_replacement[customer[:id]][:default_address]
+      end
+
+      orders[index]['customer'] = customer_replacement[old_customer]
+    end
+
+    orders
+  end
+
+end

data/test/resources/modify_data.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ModifyData
+  Faker::Config.locale = :"en-CA"
+
+  # Replace the shop data from real stores with randomly generated data
+  def self.anonymize_shop(raw_store_data)
+
+    store_data = JSON.parse(raw_store_data).fetch('shop') rescue (return raw_store_data)
+
+    # Store Details
+    store_data['id'] = Faker::Number.number(8) if store_data['id']
+    store_data['name'] = Faker::Company.name if store_data['name']
+    store_data['domain'] = Faker::Internet.url if store_data['domain']
+
+    # Owner
+    store_data['shop_owner'] = Faker::Name.name if store_data['shop_owner']
+    store_data['phone'] = Faker::PhoneNumber.phone_number if store_data['phone']
+    store_data['email'] = Faker::Internet.email if store_data['email']
+    store_data['customer_email'] = Faker::Internet.email if store_data['customer_email']
+
+    # Address
+    store_data['city'] = Faker::Address.city if store_data['city']
+    store_data['address1'] = Faker::Address.street_address if store_data['address1']
+    store_data['longitude'] = Faker::Address.longitude if store_data['longitude']
+    store_data['latitude'] = Faker::Address.latitude if store_data['latitude']
+    store_data['zip'] = Faker::Address.zip if store_data['zip']
+
+    # Set data back under the json 'shop' key and return as JSON
+    updated_store_data = JSON.parse('{}')
+    updated_store_data['shop'] = store_data
+    updated_store_data.to_json
+  end
+
+
+  # Intercept Shopify Orders and replace data with generated mock data
+  # Ensure predictable replacements of data
+  # e.g. If a real order from John Galt is replaced with a fake name, Jane Smith,
+  # every instance of John Galt should be replaced with the same data.
+  def self.anonymize_orders(raw_order_data)
+
+    order_data = JSON.parse(raw_order_data).fetch('orders') rescue (return raw_order_data)
+
+    order_data = anonymize_discounts(order_data)
+    order_data = anonymize_referrals(order_data)
+    order_data = anonymize_billing_address(order_data)
+    order_data = anonymize_line_items(order_data)
+    order_data = anonymize_customers(order_data)
+
+    # Set data back under the json 'orders' key and return as JSON
+    updated_order_data = JSON.parse('{}')
+    updated_order_data['orders'] = order_data
+    updated_order_data.to_json
+  end
+
+
+  # Traverse through orders and return a new array with each order <multiplier_constant> times
+  def self.duplicate_orders(raw_order_data, multiplier_constant:)
+    begin
+      order_data = JSON.parse(raw_order_data).fetch('orders')
+    rescue
+      return raw_order_data
+    end
+
+    duplicated_order_data = []
+
+    order_data.each do |order|
+      multiplier_constant.to_i.times { duplicated_order_data << order }
+    end
+
+    # Set data back under the json 'orders' key and return as JSON
+    returned_order_data = JSON.parse('{}')
+    returned_order_data['orders'] = duplicated_order_data
+    returned_order_data.to_json
+  end
+
+
+  # Ensure at least <floor> orders exist, or otherwise continually append the last order until enough orders exist
+  def self.number_of_orders_floor(raw_order_data, floor:)
+    order_data = JSON.parse(raw_order_data).fetch('orders') rescue (return raw_order_data)
+
+    order_delta = order_data.length - floor
+    return raw_order_data if order_delta >= 0
+
+    order_delta.to_i.times { new_order_data << order_data.last }
+
+    # Set data back under the json 'orders' key and return as JSON
+    returned_order_data = JSON.parse('{}')
+    returned_order_data['orders'] = new_order_data
+    returned_order_data.to_json
+  end
+
+
+  # Ensure no more than <ceiling> orders exist, or otherwise clip the array at <ceiling>
+  def self.number_of_orders_ceiling(raw_order_data, ceiling:)
+    order_data = JSON.parse(raw_order_data).fetch('orders') rescue (return raw_order_data)
+    trimmed_order_data = []
+
+    order_delta = ceiling - order_data.length
+    return raw_order_data if order_delta >= 0
+
+    ceiling.to_i.times { |i| trimmed_order_data << order_data[i] }
+
+    # Set data back under the json 'orders' key and return as JSON
+    returned_order_data = JSON.parse('{}')
+    returned_order_data['orders'] = trimmed_order_data
+    returned_order_data.to_json
+  end
+
+end