bootic_cli 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6ab030919ecb399f1cda0030a9573b1dc1cebd7
-  data.tar.gz: 3f6079156d89e0c6c18909453e3e50566d461283
+  metadata.gz: d367fc55f094ab200cc69836ed66a79c153ce766
+  data.tar.gz: a3aeee896b866038b588991bab6bb742a1c7114b
 SHA512:
-  metadata.gz: ff7ae4987db9ab03c59ad9628a12470a0ced9088e10372252b590ecd297a22eb8406fb663d574e24bacd817371fb9fa4b54a87c9486cdb519ea47f82f97a50b4
-  data.tar.gz: 63feac3baa1a355bd88c14cc11ed82fb1968370b364bad4310ee9cd3b8d6f29669d0dad28535f6e4dd567a74558a85e3e6818e151262e8356b28e2a4296b2b42
+  metadata.gz: f057c66358b85c1ceb1d58e874922a5ceec891aca95e9039e7a784d36d7fdb97662345d633e868d56eac19f7e0b09e95654ba3fe2fc5602120a5c808320f8498
+  data.tar.gz: e5ff8006d9b702befaf184822258306c194a947841ad5af8e7b3fa923ba5d4b0c6ca98cfa5df92e7c03f67fe5ddf91e3c9383c66a5455344f9216d60fb492cb2

data/GUIA.md

@@ -0,0 +1,106 @@
+# Guía para usar la línea de comandos de Bootic (Bootic CLI)
+
+El CLI de Bootic es una herramienta para diseñadores y desarrolladores que
+quieran realizan tareas con la API de Bootic en forma local, ya sea para ver
+o modificar datos, o bien para realizar cambios en la plantilla de la tienda.
+
+## ¿Cómo se instala?
+
+El CLI lo proveemos como una gema en `rubygems.org`, y requiere de 
+Ruby 2.2 o superior. Afortunadamente, en versiones recientes de macOS, 
+ya viene instalado Ruby 2.3 (esto lo puedes comprobar corriendo `ruby -v`
+en un terminal).
+
+    $ ruby -v
+    ruby 2.3.3p222 (2016-11-21 revision 56859) [universal.x86_64-darwin17]
+
+Perfectirijillo. El paso siguiente es asegurarse que estén instaladas 
+las Developer Tools de Xcode:
+
+    $ xcode-select --install
+
+Hecho eso, podemos instalar la gema:
+
+    $ sudo gem install bootic_cli
+
+Lo cual debería escupir un montón de texto, y terminar con algo así como
+"23 gems installed" si todo salió bien.
+
+## ¿Cómo configurarlo?
+
+Antes de poder usarlo, el CLI necesita saber que tú eres tú para saber a
+qué datos darte acceso. Para eso corremos:
+
+    $ bootic setup
+
+Te va a hacer algunas preguntas, pero el resumen es que debes entrar a 
+https://auth.bootic.net/dev/cli, seguir los pasos, y luego copiar las 
+credenciales de acceso que veas ahí. 
+
+Esto sólo hay que hacerlo una vez, por si aca.
+
+## Primeros pasos y clonar plantilla
+
+- En el terminal, para moverte entre carpetas se escribe `cd [nombreCarpeta]`,
+  por ejemplo `cd proyectos`. Si quieres subir un nivel, el comando es `cd ..`
+
+- Siempre puedes correr el comando `pwd` para saber la ruta completa de la
+  carpeta en la que estás. el comando `ls` (con ELE) te muestra los archivos
+  y carpetas que hay en la ruta que estés.
+
+- Una vez dentro de tu carpeta de trabajo (por ejemplo, `/Users/pedro/proyectos/supercliente`),
+  escribe `bootic themes clone`.
+
+- Con esto se va a descargar una copia de la plantilla de tu tienda (la que
+  esté asociada a la cuenta con la que te logueaste antes).
+
+- La plantilla se guardará en una carpeta con el mismo subdominio que la tienda.
+  deberías verla si corres `ls`.
+
+## Modificando el código
+
+- Luego, una vez dentro de esa carpeta (cd subdominio), puedes correr los
+  siguientes comandos:
+
+  - `bootic themes compare` para comparar los cambios entre tu version local y
+     la versión que está arriba,
+  - `bootic themes pull` para bajar cualquier cambio que haya arriba,
+  - `bootic themes push` para subir cualquier cambio que hagas local,
+  - `bootic themes sync` para sincronizar los cambios de arriba con los tuyos
+     (gana el archivo más reciente en cada lado), y por último,
+  - `bootic themes watch` que se queda escuchando cualquier cambio local que
+     ocurra, y cuando crees o cambies o elimines un archivo lo sube automáticamente.
+
+El sitio lo sigues viendo "a distancia", remotamente, pero usando `bootic themes watch`
+es casi instantáneo.
+
+Todos estos cambios los puedes hacer directamente sobre el sitio público,
+o bien hacerlo sobre el sitio/plantilla de desarrollo, que puedes crear al
+momento de correr el comando `clone`.
+
+Si elijes crear una plantilla de desarrollo todos los cambios que hagas van
+a ser sobre un sitio de desarrollo, en `https://url.del.sitio/preview/dev`.
+Los sitios de desarrollo no tienen caché, así que cualquier cambio que hagas
+deberías verlo ipso-facto y sin retrasos.
+
+## Publicando los cambios cambios
+
+Y finalmente, cuando quieras subir los cambios de la plantilla de desarrollo
+al sitio público, corres `bootic themes publish`. Esto obviamente no aplica
+en caso de que estés trabajo directamente sobre la plantilla pública.
+
+En caso de que inicialmente no hayas creado una plantilla de desarrollo y
+luego quieras hacerlo, basta con que elimines la carpeta y corras el comando
+`bootic clone` de nuevo.
+
+## ¿Cómo lo hago para bajar la plantilla de otra tienda?
+
+En ese caso debes correr `bootic login` para loguearte usando las credenciales
+asociadas a la otra tienda. El CLI te advertirá que ya estás logueado (en caso
+de que ya lo estés), pero simplemente dile que sí, que quieres reemplazar las
+credenciales actuales por otras.
+
+## Tengo más preguntas. ¿Qué hago?
+
+Escríbenos a soporte@bootic.io o por el chat de soporte dentro del panel de 
+la tienda.

data/README.md

@@ -1,10 +1,10 @@
 # Bootic CLI
 
-CLI to interact with the [Bootic.net API](https://developers.bootic.net/) and run custom API scripts.
+CLI to interact with the [Bootic API](https://api.bootic.net/) and run custom API scripts. [Aquí hay una guía](https://github.com/bootic/bootic_cli/blob/master/GUIA.md) en castellano que explica cómo se instala y usa.
 
 ## Installation
 
-Install in your system.
+Install via Rubygems:
 
     gem install bootic_cli
 
@@ -71,10 +71,10 @@ bootic runner list_products.rb
 
 ### Custom Thor commands
 
-More advanced scripts can be written as [Thor]() commands. Any scripts in `~/.bootic` will be loaded automatically.
+More advanced scripts can be written as [Thor]() commands. Any scripts in `~/bootic` will be loaded automatically.
 
 ```ruby
-# ~/.bootic/list_products
+# ~/.bootic/list_products.rb
 class ListProducts < BooticCli::Command
 
   desc "list", "list products by status"
@@ -84,7 +84,8 @@ class ListProducts < BooticCli::Command
       puts p.title
     end
   end
-
+  
+  declare self, "list_products"
 end
 ```
 

data/lib/bootic_cli/commands/themes.rb

@@ -13,7 +13,7 @@ module BooticCli
       # end
 
       desc 'clone [dir]', 'Clone remote theme into directory [dir]'
-      option :shop, banner: '<shop_subdomain>', type: :string
+      option :shop, banner: '<shop_subdomain>', aliases: '-s', type: :string
       option :public, banner: '<true|false>', type: :boolean, aliases: '-p', desc: 'Clones public theme, even if dev theme exists'
       option :dev, banner: '<true|false>', type: :boolean, aliases: '-d', desc: 'Clones development theme, or creates one if missing'
       def clone(dir = nil)

data/lib/bootic_cli/themes/api_theme.rb

@@ -7,6 +7,10 @@ module BooticCli
       def updated_on
         Time.parse(super)
       end
+
+      def ==(other)
+        self.updated_on == other.updated_on
+      end
     end
 
     class APIAsset < ItemWithTime
@@ -16,6 +20,11 @@ module BooticCli
           StringIO.new(data)
         )
       end
+
+      def ==(other)
+        return super if digest.to_s == '' || other.digest.to_s == ''
+        self.file_size == other.file_size && self.digest == other.digest
+      end
     end
 
     class APITheme
@@ -32,10 +41,9 @@ module BooticCli
         theme.can?(:publish_theme)
       end
 
-      def publish(clone = false)
+      def publish
         if theme.can?(:publish_theme)
           @theme = theme.publish_theme
-          @theme.create_dev_theme if clone
           reload!(false)
         end
       end
@@ -53,11 +61,11 @@ module BooticCli
       end
 
       def templates
-        @templates ||= theme.templates.map{|t| ItemWithTime.new(t) }
+        @templates ||= theme.templates.map { |t| ItemWithTime.new(t) }
       end
 
       def assets
-        @assets ||= theme.assets.map{|t| APIAsset.new(t) }
+        @assets ||= theme.assets.map { |t| APIAsset.new(t) }
       end
 
       def add_template(file_name, body)

data/lib/bootic_cli/themes/fs_theme.rb

@@ -1,11 +1,30 @@
 require 'fileutils'
 require 'yaml/store'
+require 'digest/md5'
 
 module BooticCli
   module Themes
     class FSTheme
-      Template = Struct.new(:file_name, :body, :updated_on)
-      ThemeAsset = Struct.new(:file_name, :file, :updated_on)
+
+      Template = Struct.new(:file_name, :body, :updated_on) do
+        def ==(other)
+          self.updated_on == other.updated_on
+        end
+      end
+
+      ThemeAsset = Struct.new(:file_name, :file, :updated_on) do
+        def body; @body ||= file.read; end
+        def file_size; body.length; end
+        def digest; @digest ||= Digest::MD5.hexdigest(body); end
+
+        def ==(other)
+          if other.digest.to_s == '' # api theme asset without a digest set
+            return self.updated_on == other.updated_on
+          end
+
+          self.file_size == other.file_size && self.digest == other.digest
+        end
+      end
 
       ASSETS_DIR = 'assets'.freeze
       TEMPLATE_PATTERNS = ['*.liquid', '*.html', '*.css', '*.js', 'theme.yml'].freeze
@@ -19,11 +38,11 @@ module BooticCli
 
       def self.resolve_file(path)
         file = File.new(path)
-        file_name = File.basename(path)
         type = resolve_type(path)
+        file_name = File.basename(path)
 
         item = if path =~ /assets\//
-          ThemeAsset.new(file_name, file.read, file.mtime.utc)
+          ThemeAsset.new(file_name, file, file.mtime.utc)
         else
           Template.new(file_name, file.read, file.mtime.utc)
         end

data/lib/bootic_cli/themes/updated_theme.rb

@@ -41,7 +41,7 @@ module BooticCli
       attr_reader :source, :target, :force_update
 
       def should_update?(a, b)
-        force_update || more_recent?(a, b)
+        force_update || (a != b && more_recent?(a, b))
       end
 
       def more_recent?(a, b)

data/lib/bootic_cli/themes/workflows.rb

@@ -110,12 +110,12 @@ module BooticCli
         # now, download missing files on local end
         notice 'Downloading missing local templates & assets...'
         copy_templates(diff.missing_in_source, local_theme, download_opts)
-        copy_assets(diff.missing_in_source, local_theme, overwrite: true)
+        copy_assets(diff.missing_in_source, local_theme, download_opts)
 
         # now, upload missing files on remote
         notice 'Uploading missing remote templates & assets...'
         copy_templates(diff.missing_in_target, remote_theme, download_opts)
-        copy_assets(diff.missing_in_target, remote_theme, overwrite: true)
+        copy_assets(diff.missing_in_target, remote_theme, download_opts)
 
         prompt.say "Synced! Preview this theme at #{remote_theme.path}", :cyan
       end
@@ -132,10 +132,14 @@ module BooticCli
         notice "Local <--- Remote"
 
         diff.updated_in_target.templates.each do |t|
-          puts "Updated in remote: #{t.file_name} (updated at #{t.updated_on})"
+          puts "Updated template in remote: #{t.file_name} (updated at #{t.updated_on})"
           puts t.diff.to_s(:color)
         end
 
+        diff.updated_in_target.assets.each do |t|
+          puts "Updated asset in remote: #{t.file_name} (updated at #{t.updated_on})"
+        end
+
         diff.missing_in_source.templates.each do |t|
           puts "Remote template not in local dir: #{t.file_name}"
         end
@@ -151,6 +155,10 @@ module BooticCli
           puts t.diff.to_s(:color)
         end
 
+        diff.updated_in_source.assets.each do |t|
+          puts "Updated locally: #{t.file_name} (updated at #{t.updated_on})"
+        end
+
         diff.missing_in_target.templates.each do |f|
           puts "Local template not in remote: #{f.file_name}"
         end
@@ -213,7 +221,7 @@ module BooticCli
         end
 
         prompt.notice "Alrighty! Publishing your development theme..."
-        remote_theme.publish(true) # syncs dev to public, without flipping them
+        remote_theme.publish # syncs dev to public, without flipping them
         prompt.notice "Yay! Your development theme has been made public. Take a look at #{remote_theme.path}"
       end
 
@@ -275,7 +283,7 @@ module BooticCli
           if opts[:overwrite]
             true
           else
-            target_asset = to.assets.find{ |t| t.file_name == a.file_name }
+            target_asset = to.assets.find { |t| t.file_name == a.file_name }
             if target_asset
               opts[:interactive] && prompt.yes_or_no?("Asset exists: #{highlight(a.file_name)}. Overwrite?", false)
             else

data/lib/bootic_cli/version.rb

@@ -1,3 +1,3 @@
 module BooticCli
-  VERSION = "0.4.5"
+  VERSION = "0.4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_cli
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -146,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- GUIA.md
 - Gemfile
 - LICENSE.txt
 - README.md