bootic_cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f2a3c068eab8692e48632559045c3df977266d3
-  data.tar.gz: 26ebde53b193412f58110f95bfd72e2cec736ace
+  metadata.gz: 1cf13197e1e1dc7d25ccba82f1d82163ce9f148f
+  data.tar.gz: 4716c8976aec0a34fa4c4b4efcb2e3cb56fadbcd
 SHA512:
-  metadata.gz: 3f0ad5def58d8eaabdf3535aaf0cacc17d70fa401d45c39f280edc0f798737bcea68220bc51ba4e7229c684d0b3c5cfdbe9bb2e90101c273469e0ed93d273035
-  data.tar.gz: ad5d228ff4e5b31eeb8696baef6744cf206919100f8582a0f7f04cf0285376415739f0ccefa42e885a137600dacabc0ce0865a8365d09fa246d5dd602db52bb4
+  metadata.gz: 253dc69ae10e863e15ab38f54ec701045b349ed8de7fefa1cf0faf3db8d4df9f2db8cfe74db60d78f8dbb44900b2011bcb4686ead781abc9c03907605080fbf4
+  data.tar.gz: c689a4cbe09eda6b6043ab6fa8595b668a747eace1f32caa00331a74a1ba8035af376c46adc5d2a6bbc7bebd836918db82bf2d4147545abf5afdc929f63d51eb

data/README.md

@@ -1,8 +1,6 @@
 # Bootic CLI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/btc`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+CLI to interact with the [Bootic.net API](https://developers.bootic.net/) and run custom API scripts.
 
 ## Installation
 
@@ -20,6 +18,81 @@ btc login
 btc console
 ```
 
+### Console
+
+`btc 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
+
+explain shop
+
+list shop.products
+
+explain_link shop, :products
+```
+
+### Custom scripts
+
+You can run simple Ruby scripts in the context of an API session with
+
+```
+btc runner my_script.rb
+```
+
+Your script will be provided with the following variables
+
+```ruby
+# the API root resource
+root
+
+# your default shop
+shop
+```
+
+An example script that lists your shop's products
+
+```ruby
+# list_products.rb
+shop.products.full_set.each do |pr|
+  puts pr.title
+end
+```
+
+You run it with
+
+```
+btc runner list_products.rb
+```
+
+### Custom Thor commands
+
+More advanced scripts can be written as [Thor]() commands. Any scripts in `~/btc` will be loaded automatically.
+
+```ruby
+# ~/btc/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
+  end
+end
+```
+
+Now `btc help` will list your custom `list_products` command.
+
+```
+btc help list_products
+
+# list hidden products
+btc 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.
@@ -28,7 +101,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/btc/fork )
+1. Fork it ( https://github.com/bootic/bootic_cli/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/bootic_cli/cli.rb

@@ -27,7 +27,7 @@ module BooticCli
         invoke :setup, []
       end
 
-      username  = ask("Enter your Bootic user name:")
+      username  = ask("Enter your Bootic email")
       pwd       = ask("Enter your Bootic password:", echo: false)
 
       say "Loging in as #{username}. Getting access token..."
@@ -118,15 +118,23 @@ module BooticCli
         downcase.split("/").last
     end
 
+    def self.load_file(f)
+      begin
+        require f
+      rescue LoadError => e
+        puts "#{e.class} loading #{f}: #{e.message}"
+      end
+    end
+
     require "bootic_cli/command"
 
     Dir[File.join(File.dirname(__FILE__), 'cli', '*.rb')].each do |f|
-      require f
+      load_file f
     end
 
     if File.directory?(CUSTOM_COMMANDS_DIR)
       Dir[File.join(CUSTOM_COMMANDS_DIR, '*.rb')].each do |f|
-        require f
+        load_file f
       end
     end
   end

data/lib/bootic_cli/version.rb

@@ -1,3 +1,3 @@
 module BooticCli
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor