Birst_Command 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58f9b1e8e6efa926c798dce89e9135c72faa9899
-  data.tar.gz: bdac960c6a738e563bec501a64adf03bd7eae28b
+  metadata.gz: 662351a7efa2b85710e7eb37986a00bc452c0c92
+  data.tar.gz: fec8a4a7cf294a572a937e26a7ab50192e6d18b6
 SHA512:
-  metadata.gz: f7d27fb486170d53a80d6bf946672d2f71cb8e29ed2c292827452f35fb1c21789c6a894816d72dd959b5f06301d7c4da606440dbc6f1bd5c31a89ea8d3c51bf2
-  data.tar.gz: 144d996dd5e0bd9fbd8d73bdd0cfa70a5345371a85084b2fef7ea321f5964e710e0a870c366aacc83c02181135768b1548fb688987806e3a77f91505818763fb
+  metadata.gz: b71cce7ef718ca3d3d2409002208dc83826d37c7b5ba8970c403aabc48cd9fdd1792992f7b9fdcacb8dca8cc529b659917b80589e79f5a0da4e76fea3ca14345
+  data.tar.gz: 1d8b12dc02b8b293540fedb866c95b3013b8ae270ff1a3de2356d4c44a3d8835d369e0d76e6d536a384d5e6fcfb4f3386f9323087373a2736f9bfe72ac416bd0

data/Birst_Command.gemspec

@@ -12,8 +12,9 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.summary     = "Birst Command"
   s.description = "Ruby interface to Birst web API"
-
   s.rubyforge_project = "Birst_Command"
+
+  s.required_ruby_version = '~> 2'
   s.add_runtime_dependency "savon", ["~> 2.0"]
   s.add_runtime_dependency "httpclient", ["~> 2.3"]
 

data/README.md

@@ -36,7 +36,7 @@ to a secure location**.  If any attacker is able to get your
 obfuscated password and knows it was created using this program, it
 would be trivial to get your Birst login credentials.
 
-# Usage - Command-line tool
+# Usage - Birst command line tool
 
 Birst Command also installs a rudimentary command line tool for interacting
 with the Birst web API.  It's still very simple.  If you want more functionality,
@@ -65,45 +65,51 @@ Copy space with options
 
 In your Ruby program, include the Birst Command gem and load the config file via
 
-    require 'rubygems'
-    require 'bundler/setup'
-    require 'Birst_Command'
+````ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'Birst_Command'
 
-    Birst_Command::Config.read_config(File.join(File.dirname(__FILE__),"config.json"))
+Birst_Command::Config.read_config(File.join(File.dirname(__FILE__),"config.json"))
+````
 
 Birst commands are submitted in session blocks, which automatically
 perform the process of logging in, tracking the login token, and
 logging out.  For example, to list all spaces that you have rights to,
 you can submit the following code
 
-    Birst_Command::Session.start do |bc|
-      spaces = bc.list_spaces
-      puts "#{JSON.pretty_generate spaces}"
-    end
+````ruby
+Birst_Command::Session.start do |bc|
+  spaces = bc.list_spaces
+  puts "#{JSON.pretty_generate spaces}"
+end
+````
 
 Which would return something like
 
+````ruby
+{
+  "user_space": [
     {
-      "user_space": [
-        {
-          "name": "MyGreatSpace",
-          "owner": "name@myplace.com",
-          "id": "b413207d-3fe2-4309-1b4a-ac8e961daad2"
-        },
-        {
-          "name": "MyOtherGreatSpace",
-          "owner": "name@myplace.com",
-          "id": "a113207d-3fe2-4310-1b4a-b58e961da123"
-        }
-      ]
+      "name": "MyGreatSpace",
+      "owner": "name@myplace.com",
+      "id": "b413207d-3fe2-4309-1b4a-ac8e961daad2"
+    },
+    {
+      "name": "MyOtherGreatSpace",
+      "owner": "name@myplace.com",
+      "id": "a113207d-3fe2-4310-1b4a-b58e961da123"
     }
+  ]
+}
+````
 
 The `spaces` variable is a Ruby hash parsed from the SOAP response.
 The structure of the returned hash follows the structure that Birst
 returns.
 
 
-## Helper Methods
+## Helper methods
 
 I find some of the Birst API responses to be rather cumbersome.  For
 example, why do I need hash with a single `user_space` key?  I'd
@@ -112,12 +118,14 @@ to define helper methods that extend the Session class to simplify
 some of this.  To override the return value of the native
 `list_spaces` command, you can do the following
 
-    class Birst_Command::Session
-      def list_spaces(*args)
-        result = command __method__, *args
-        [result[:user_space]].flatten
-      end 
-    end
+````ruby
+class Birst_Command::Session
+  def list_spaces(*args)
+    result = command __method__, *args
+    [result[:user_space]].flatten
+  end 
+end
+````
 
 You can then execute the same `list_spaces` command above, but you get
 an array of hashes rather than hash with a key that points to an array
@@ -132,11 +140,13 @@ provides the basic interface.
 Some Birst API commands require arguments.  All arguments are supplied
 as an argument hash.  For example, to create a new space,
 
-    Birst_Command::Session.start do |bc|
-      new_space_id = bc.create_new_space :spaceName => "myNewSpace",
-                                         :comments => "Just testing",
-                                         :automatic => "false"
-    end
+````ruby
+Birst_Command::Session.start do |bc|
+  new_space_id = bc.create_new_space :spaceName => "myNewSpace",
+                                     :comments => "Just testing",
+                                     :automatic => "false"
+end
+````
 
 ## camelCase/snake_case issues
 

data/bin/birstcl

@@ -1,11 +1,5 @@
 #!/usr/bin/env ruby
 
-# FOR TESTING ONLY
-$LOAD_PATH << File.join(File.dirname(__FILE__),"../lib")
-require 'rubygems'
-require 'bundler/setup'
-# REMOVE THE ABOVE
-
 require "birst_command"
 require "optparse"
 
@@ -22,6 +16,11 @@ module BirstCL
         @options[:verbose] = v
       end
 
+      @options[:version] = false
+      opts.on("--version", "--version", "Print version") do |v|
+        @options[:version] = true
+      end
+      
       opts.on("-h","--help", "Show this message") do
         puts opts
         exit
@@ -49,6 +48,11 @@ module BirstCL
         @options[:config_full_path] = opt
       end
     end.parse!
+
+    if @options[:version]
+      puts "Birst_Command Version: #{Birst_Command::VERSION}"
+      exit
+    end
   end
 
 

data/lib/birst_command/version.rb

@@ -1,3 +1,3 @@
 module Birst_Command
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Birst_Command
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sterling Paramore
@@ -85,9 +85,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ~>
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='