binda-shopify 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0de8e1630d6d3ca6fe0992c338bf2f1183969b48
-  data.tar.gz: 2a4d86220701a66cd14003d69d2d2cf57493c196
+  metadata.gz: b088e0b53767852425a86f735f89859a9dc4ef5f
+  data.tar.gz: af65fce8b0df37293586008063c54d2dd6fb5e0b
 SHA512:
-  metadata.gz: 67f93ad5bbe7a74860849871ec3d6235306eda5af4d82416cdc8acfe20335ed6fd3c482e93b82ac804704133b78e1daf66df726a408250d08b16d46c349e8798
-  data.tar.gz: 931d0fb4afeb6bf8f970f9a37e8e311dfae2673836d63a62f4c6f0129708955adfc200438610eca4d33d1948389a52f29fae2c1a3b74ceb215c7933a48c786e0
+  metadata.gz: 385050f8102f201471c69da9479953aa12e0f5b198d37dcd6561e2b6d8e7742fb0bb967e2f2b36fdadf563fb80c7720cd13606d63644dca4105aa9acfb2a715f
+  data.tar.gz: 62430e157c995084b1cc3efdb0d1d1f9e5313a2490c5386d8f6bad55b953f822f536dcee27ee956cc1b2e754b93b9c32e2a794dadefc52a5684c5fe974b5e1ff

data/README.md

@@ -6,9 +6,19 @@ Extension that lets you import your Shopify products into your Binda application
 [![Maintainability](https://api.codeclimate.com/v1/badges/00f7b3a4bb33ea7637c2/maintainability)](https://codeclimate.com/github/lacolonia/binda-shopify/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/00f7b3a4bb33ea7637c2/test_coverage)](https://codeclimate.com/github/lacolonia/binda-shopify/test_coverage)
 
-# Installation
 
-Install Binda via terminal
+## Requirements
+
+Before you install **Binda Shopify** you need to setup your Shopify account properly. Please follow the steps below.
+
+### Create a private app
+
+Binda Shopify relies on private apps. A detailed guide on what are and how to create them can be found in the [Shopify official documentation](https://help.shopify.com/manual/apps/private-apps).
+
+## Installation
+
+If you haven't read the **Requirements** section do it now before continuing.
+Install Binda via terminal. See [Binda installation guide](https://www.rubydoc.info/gems/binda#Installation) for more information.
 
 Just add the gem to your application's Gemfile:
 
@@ -22,10 +32,26 @@ Then, run:
 bundle install
 ```
 
-After that, you need to setup your connection to Shopify and create `Binda::Structures` where your data will be imported.
+After that, you need to setup your connection to Shopify and create `Binda::Structures` where your data will be imported. To do so you can run the following command.
+
+_Development env_
 
 ```bash
-bundle exec rails generate binda:shopify:install
+rails generate binda:shopify:install
 ```
 
-Now you are good to go!
+_Production env_
+
+```bash
+RAILS_ENV=production bundle exec rails generate binda:shopify:install
+```
+
+> #### NOTE
+> 
+> Your Shopify **shop name**, which is required during the installation process, corresponds to the subdomain portion of you shopify store. 
+> 
+> For example: for `https://cool-shoes.myshopify.com` the Shopify **shop name** is `cool-shoes`.
+> 
+> Don't confuse it with the private app name.
+
+Once you complete the installation process you are good to go! Log into your admin panel and click the sync button.

data/app/views/shared/_synchronize.html.erb

@@ -1,5 +1,7 @@
-<li>
-  <a class="synch-with-shopify" data-message="<%= I18n.t('binda.shopify.loading') %>" data-success="<%= I18n.t('binda.shopify.success') %>" href="<%= shopify_import_path %>">
-    <i class="fas fa-sync"></i> <%= I18n.t('binda.shopify.synch_with_shopify') %>
-  </a>
-</li>
+<% if Binda::Structure.where(slug: "shopify-settings").any? %>
+  <li>
+    <a class="synch-with-shopify" data-message="<%= I18n.t('binda.shopify.loading') %>" data-success="<%= I18n.t('binda.shopify.success') %>" href="<%= shopify_import_path %>">
+      <i class="fas fa-sync"></i> <%= I18n.t('binda.shopify.synch_with_shopify') %>
+    </a>
+  </li>
+<% end %>

data/lib/binda/shopify/collection.rb

@@ -1,3 +1,4 @@
+require 'binda/shopify/item'
 module Binda
   module Shopify
     class Collection < Item

data/lib/binda/shopify/importer.rb

@@ -2,13 +2,20 @@ require 'shopify_api'
 
 module Binda
   module Shopify
+    # Shopify Importer
+    #
+    # This class is responsible for fetching data from a Shopify account
     class Importer
       attr_accessor :client, :settings
 
       def initialize
         settings_slug = 'shopify-settings'
         @settings = ::Binda::Structure.find_by(slug: 'shopify-settings').board
-        api_key, password, shared_secret, shop_name = ::Binda::Shopify::CONNECTION_KEYS.map{|field| settings.get_string("#{settings_slug}-#{field.to_s.gsub('_', '-')}").strip }
+        connection_keys = ::Binda::Shopify::CONNECTION_KEYS.map do |field|
+          slug = "#{settings_slug}-#{field.to_s.tr('_', '-')}"
+          settings.get_string(slug).strip
+        end
+        api_key, password, shared_secret, shop_name = connection_keys
 
         @client = ::ShopifyAPI
         @client::Base.site = "https://#{api_key}:#{password}@#{shop_name}.myshopify.com/admin"
@@ -18,67 +25,86 @@ module Binda
       def run!
         start_time = Time.now
         ::Binda::Shopify::STRUCTURES.each do |name, structure_fields|
-          structure_slug = settings.get_string("#{@settings.slug}-#{name.to_s.gsub('_', '-')}").strip.parameterize
+          slug = "#{@settings.slug}-#{name.to_s.tr('_', '-')}"
+          structure_slug = settings.get_string(slug).strip.parameterize
           structure = ::Binda::Structure.find_by slug: structure_slug
-          send("fetch_#{name.to_s.pluralize}").each do |item|
-            if item.id.present?
-              component = ::Binda::Component.find_or_initialize_by slug: item.id, structure: structure
-              component.name ||= item.title
-              component.publish_state = 'published'
-              component.updated_at = Time.now
-              component.save
-              structure_fields.each do |field_group_slug, fields|
-                field_group_slug = "#{structure_slug}-#{field_group_slug}"
-                field_group = structure.field_groups.find_by slug: field_group_slug
-                if field_group
-                  fields.each do |field_slug_and_type, method|
-                    field_slug, type = field_slug_and_type.split(':')
-                    type ||= 'string'
-
-                    field_setting = field_group.field_settings.find_by(slug: "#{field_group_slug}-#{field_slug}")
-                    field_type_association = type.pluralize
-                    if ::Binda::Component.reflections.keys.include? field_type_association
-                      component.send(field_type_association).find_by(field_setting_id: field_setting.id).update content: item.send(method) if field_setting
-                    end
-                  end
-                end
-              end
-            end
-          end
-          structure.components.where("updated_at < ?", start_time).update_all publish_state: 'draft'
+          create_component_and_fields(name, structure_fields, structure)
+          structure
+            .components
+            .where('updated_at < ?', start_time)
+            .update_all(publish_state: 'draft')
         end
-
         ::Binda::Shopify::STRUCTURES.keys
       end
 
-      def fetch_collections
-        items = []
-        number_of_pages = (@client::CustomCollection.count / 250.0).ceil
-        number_of_pages.times do |i|
-          @client::CustomCollection.find(:all, params: { limit: 250, page: i+1}).each do |p|
-            items << ::Binda::Shopify::Collection.new(p, shop)
-          end
+      def create_component_and_fields(name, structure_fields, structure)
+        send("fetch_#{name.to_s.pluralize}").each do |item|
+          next unless item.id.present?
+          component = ::Binda::Component.find_or_initialize_by(
+            slug: item.id,
+            structure: structure
+          )
+          component.name ||= item.title
+          component.publish_state = 'published'
+          component.updated_at = Time.now
+          component.save
+          create_fields(structure_fields, structure, component, item)
         end
+      end
 
-        items
+      def create_fields(structure_fields, structure, component, item)
+        structure_fields.each do |field_group_slug, fields|
+          field_group_slug = "#{structure.slug}-#{field_group_slug}"
+          field_group = structure.field_groups.find_by(slug: field_group_slug)
+          next unless field_group
+          create_field(field_group, fields, component, item)
+        end
       end
 
-      def fetch_products
+      def create_field(field_group, fields, component, item)
+        fields.each do |field_slug_and_type, method|
+          field_slug, type = field_slug_and_type.split(':')
+          type ||= 'string'
+          next unless ::Binda::Component.reflections.key? type.pluralize
+          field_setting = field_group.field_settings.find_by(
+            slug: "#{field_group.slug}-#{field_slug}"
+          )
+          next unless field_setting
+          component
+            .send(type.pluralize)
+            .find_by(field_setting_id: field_setting.id)
+            .update(content: item.send(method))
+        end
+      end
+
+      def fetch(client_source, binda_source)
         items = []
-        number_of_pages = (@client::Product.count / 250.0).ceil
+        number_of_pages = (client_source.count / 250.0).ceil
         number_of_pages.times do |i|
-          @client::Product.find(:all, params: { limit: 250, page: i+1}).each do |p|
-            items << ::Binda::Shopify::Product.new(p, shop)
+          fetched_sources = client_source.find(
+            :all,
+            params: { limit: 250, page: i + 1 }
+          )
+          fetched_sources.each do |p|
+            items << binda_source.new(p, shop)
           end
         end
 
         items
       end
 
+      def fetch_collections
+        fetch(@client::CustomCollection, ::Binda::Shopify::Collection)
+      end
+
+      def fetch_products
+        fetch(@client::Product, ::Binda::Shopify::Product)
+      end
+
       def fetch_product_types
         products = fetch_products
         product_types = products.map(&:product_type).uniq
-        product_types.map{|p| ::Binda::Shopify::ProductType.new(p, shop) }
+        product_types.map { |p| ::Binda::Shopify::ProductType.new(p, shop) }
       end
 
       def shop

data/lib/binda/shopify/installer.rb

@@ -4,7 +4,7 @@ module Binda
       def create_settings_board values
         raise ArgumentError.new 'You must provide an array or hash of settings values' unless values.is_a?(Array) || values.is_a?(Hash)
         values = Hash[(CONNECTION_KEYS+STRUCTURES.keys).zip(values)] if values.is_a? Array
-        structure = Binda::Structure.find_or_create_by( name: 'Shopify Settings', slug: 'shopify-settings', instance_type: 'board' )
+        structure = ::Binda::Structure.find_or_create_by( name: 'Shopify Settings', slug: 'shopify-settings', instance_type: 'board' )
         board = structure.board
         field_settings = structure.field_groups.first.field_settings
         CONNECTION_KEYS.each do |field_name|
@@ -26,8 +26,8 @@ module Binda
 
       def create_item_structure structure_name, name
         structure_slug = name.parameterize
-        structure = Binda::Structure.find_or_create_by name: name, slug: structure_slug, instance_type: 'component', has_categories: false
-        Binda::Shopify::STRUCTURES[structure_name.to_sym].each do |field_group_slug, fields|
+        structure = ::Binda::Structure.find_or_create_by name: name, slug: structure_slug, instance_type: 'component', has_categories: false
+        ::Binda::Shopify::STRUCTURES[structure_name.to_sym].each do |field_group_slug, fields|
           field_group = structure.field_groups.find_by slug: "#{structure_slug}-#{field_group_slug}"
           if field_group.nil?
             field_group = structure.field_groups.create! name: field_group_slug.titleize, slug: "#{structure_slug}-#{field_group_slug}"

data/lib/binda/shopify/version.rb

@@ -1,5 +1,5 @@
 module Binda
   module Shopify
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'.freeze
   end
 end

data/lib/binda/shopify.rb

@@ -1,15 +1,21 @@
+# Main classes
 require 'binda'
 require "binda/shopify/engine"
+
+# Secondary classes
+require 'binda/shopify/collection'
 require 'binda/shopify/importer'
 require 'binda/shopify/item'
 require 'binda/shopify/product'
-require 'binda/shopify/collection'
 require 'binda/shopify/product_type'
+
+# Vendor
 require 'deface'
+require 'byebug'
 
 module Binda
   module Shopify
-    CONNECTION_KEYS = %i(api_key password shared_secret shop_name)
+    CONNECTION_KEYS = %i(api_key password shared_secret shop_name).freeze
     STRUCTURES = {
       product: {
         'shopify-details' => {
@@ -30,6 +36,6 @@ module Binda
           'handle' => 'name'
         }
       }
-    }
+    }.freeze
   end
 end

data/lib/generators/binda/shopify/install_generator.rb

@@ -1,7 +1,9 @@
+require 'binda/shopify/installer'
+
 module Binda
   module Shopify
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates',__FILE__)
+      source_root File.expand_path('../templates', __FILE__)
       attr_accessor :structure
 
       def start
@@ -10,13 +12,13 @@ module Binda
 
       def create_shopify_settings
         puts "1) Setting up Shopify Connection"
-        @installer = Installer.new
+        @installer = ::Binda::Shopify::Installer.new
         @settings = {}
-        Binda::Shopify::CONNECTION_KEYS.each do |field_name|
+        ::Binda::Shopify::CONNECTION_KEYS.each do |field_name|
           STDOUT.puts "What is your Shopify #{field_name.to_s.titleize}?"
           @settings[field_name] = STDIN.gets.strip
         end
-        Binda::Shopify::STRUCTURES.each do |structure_name, structure_fields|
+        ::Binda::Shopify::STRUCTURES.each do |structure_name, structure_fields|
           default_name = "Shopify #{structure_name.to_s.titleize}"
           puts "How would you like to name your #{structure_name} structure? ['#{default_name}']"
           @settings[structure_name] = STDIN.gets.strip.presence || default_name
@@ -26,7 +28,7 @@ module Binda
       end
 
       def setup_structures 
-        Binda::Shopify::STRUCTURES.each.with_index do |(structure_name, structure_fields), index|
+        ::Binda::Shopify::STRUCTURES.each.with_index do |(structure_name, structure_fields), index|
           name = @settings[structure_name].presence || structure_name.to_s.titleize
           puts "#{index+2}) Setting up #{name} Structure"
           @installer.create_item_structure structure_name, name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binda-shopify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Marco Crepaldi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Binda plugin that lets you import products from your Shopify store.