bootic_cli 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14a54ce4a89784dff4a594eb5d16ee9b9a3bc10e
-  data.tar.gz: 3ccae9ef9c150991409e60ec8ffd2763728eaab9
+  metadata.gz: 1635165613bb3c1108f62bcf3fb9a455b66a22cc
+  data.tar.gz: b9eda84070803bdf7892769033bc5ceb4dd38b05
 SHA512:
-  metadata.gz: d0571df846d44ca03ca5385573a9e0f5dae6928bda9dbe210f3c8a403b8fbed3518c68996fd54d15fb4bfd8d9eed6c24a30cc9a5db37c5fa5a3b72adecbded13
-  data.tar.gz: 29d21d81ef59ac13ce3e832f099fa90aa453e36769646e738957ffe672d6521e1e8b2d2f2d62fea47c3b265966ff0c88650aa464572da8638d2920fe469335f2
+  metadata.gz: 2921db246029beec8a51e242a5635524a7106fc8f2d2cd93cd52b660597b4bee084ed04ef09109ee2502fce068be135a276f08d002fdbde761653d1d78fb5124
+  data.tar.gz: 07db650fb21e51a90e1042c940ada82a8af43abdb85f6a34a183caa391153bca54c6b045f4c248abfc4e8910171b9683fecfc55965dc6ad52f60cad3d732121b

data/README.md

@@ -6,50 +6,45 @@ CLI to interact with the [Bootic.net API](https://developers.bootic.net/) and ru
 
 Install in your system.
 
-```
-gem install bootic_cli
-```
+    gem install bootic_cli
 
 ## Usage
 
-```
-btc help
-btc login
-btc console
-```
+    bootic help
+    bootic setup
+    bootic login
+    bootic console
 
 ### Console
 
-`btc console` launches an API session into an IRB console. You'll have `root` and `shop` API entities already initialized for you.
+`bootic console` launches an API session into an IRB console. You'll have `root` and `shop` API entities already initialized for you.
 
 ```
-shop.orders(status: "all").each do |o|
-  puts o.total
-end
+> shop.orders(status: "all").each do |o|
+>   puts o.total
+> end
 
-explain shop
+> explain shop
 
-list shop.products
+> list shop.products
 
-explain_link shop, :products
+> explain_link shop, :products
 ```
 
 Access the configured client:
 
 ```
-client session.client
-new_root = client.from_url("https://some.endpoint.com")
+> client session.client
+> new_root = client.from_url("https://some.endpoint.com")
 ```
 
 ### Custom scripts
 
 You can run simple Ruby scripts in the context of an API session with
 
-```
-btc runner my_script.rb
-```
+    bootic runner my_script.rb
 
-Your script will be provided with the following variables
+Your script will be provided with the following variables:
 
 ```ruby
 # the API root resource
@@ -59,50 +54,52 @@ root
 shop
 ```
 
-An example script that lists your shop's products
+An example script that lists your shop's products:
 
 ```ruby
 # list_products.rb
-shop.products.full_set.each do |pr|
-  puts pr.title
+shop.products.full_set.each do |p|
+  puts p.title
 end
 ```
 
-You run it with
+You run it with:
 
 ```
-btc runner list_products.rb
+bootic runner list_products.rb
 ```
 
 ### Custom Thor commands
 
-More advanced scripts can be written as [Thor]() commands. Any scripts in `~/btc` will be loaded automatically.
+More advanced scripts can be written as [Thor]() commands. Any scripts in `~/.bootic` will be loaded automatically.
 
 ```ruby
-# ~/btc/list_products
+# ~/.bootic/list_products
 class ListProducts < BooticCli::Command
+
   desc "list", "list products by status"
   option :s, banner: "<status>"
   def list
-	shop.products(status: options["s"]).full_set.each do |pr|
-  		puts pr.title
-	end
+    shop.products(status: options["s"]).full_set.each do |p|
+      puts p.title
+    end
   end
+
 end
 ```
 
-Now `btc help` will list your custom `list_products` command.
+Now `bootic help` will list your custom `list_products` command.
 
 ```
-btc help list_products
+bootic help list_products
 
 # list hidden products
-btc list_products list -s hidden
+bootic list_products list -s hidden
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec btc` to use the code located in this directory, ignoring other installed copies of this gem.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec bootic` to use the code located in this directory, ignoring other installed copies of this gem.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,6 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-
 task :default => :spec

data/lib/bootic_cli.rb

@@ -1 +1 @@
-require "bootic_cli/cli"
+require 'bootic_cli/cli'

data/lib/bootic_cli/cli.rb

@@ -9,7 +9,7 @@ module BooticCli
     include Thor::Actions
     include BooticCli::Connectivity
 
-    CUSTOM_COMMANDS_DIR = ENV.fetch("BTC_CUSTOM_COMMANDS_PATH") { File.join(ENV["HOME"], "btc") }
+    CUSTOM_COMMANDS_DIR = ENV.fetch('BTC_CUSTOM_COMMANDS_PATH') { File.join(ENV['HOME'], 'bootic') }
 
     # override Thor's help method to print banner and check for keys
     def help
@@ -32,7 +32,7 @@ module BooticCli
       if session.setup?
         input = ask "Looks like you're already set up. Do you want to re-enter your app's credentials? [n]", :magenta
         if input != 'y'
-          say 'Thought so. Bye!'
+          say 'Thought so. You can run `bootic help` for a list of supported commands.'
           exit(1)
         end
       else
@@ -85,24 +85,24 @@ module BooticCli
       if session.logged_in?
         input = ask "Looks like you're already logged in. Do you want to redo this step? [n]", :magenta
         if input != 'y'
-          say 'Thought so. Bye!'
+          say "That's what I thought! Try running `bootic help`."
           exit(1)
         end
       end
 
-      username  = ask("Enter your Bootic email:", :bold)
-      pwd       = ask("Enter your Bootic password:", :bold, echo: false)
+      email = ask("Enter your Bootic email:", :bold)
+      pass  = ask("Enter your Bootic password:", :bold, echo: false)
 
-      if username.strip == '' or pwd.strip == ''
+      if email.strip == '' or email['@'].nil? or pass.strip == ''
         say "\nPlease make sure to enter valid data.", :red
         exit 1
       end
 
-      say "\n\nAlrighty! Getting access token for #{username}...\n"
+      say "\n\nAlrighty! Getting access token for #{email}...\n"
 
       begin
-        session.login(username, pwd, scope)
-        say "Great success! You're now logged in as #{username} (#{scope})", :green
+        session.login(email, pass, scope)
+        say "Great success! You're now logged in as #{email} (#{scope})", :green
         say "For a list of available commands, run `bootic help`."
       rescue StandardError => e
         say e.message, :red

data/lib/bootic_cli/store.rb

@@ -6,7 +6,7 @@ module BooticCli
   class Store
     VERSION = 1
     DEFAULT_NAMESPACE = 'production'.freeze
-    DIRNAME = '.btc'.freeze
+    DIRNAME   = '.bootic'.freeze
     FILE_NAME = 'store.pstore'.freeze
 
     def initialize(base_dir: ENV['HOME'], dir: DIRNAME, namespace: DEFAULT_NAMESPACE)

data/lib/bootic_cli/version.rb

@@ -1,3 +1,3 @@
 module BooticCli
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootic_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ismael Celis
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Bootic command-line client.