Birst_Command 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 691bdfba6622122f7364a480bf3bc86815cb134f
-  data.tar.gz: bc7df5c7106c4b897873e3d8e3f803b17bce9c76
+  metadata.gz: 58f9b1e8e6efa926c798dce89e9135c72faa9899
+  data.tar.gz: bdac960c6a738e563bec501a64adf03bd7eae28b
 SHA512:
-  metadata.gz: 759d7ade22530e03f2ca4ecdce1b679ac4204b9ce84d8d3ad0860261de0582fb2fe12c581f4cb04eb4a7b6c121fa42aac183a47e5a4eef84429d38154e770353
-  data.tar.gz: b3f7d3f5bc8cf6e3b5ef8fc8783e867a6eac89007bb4b9acd6014b8f4c5dae8c8dc0c9365465d9950f295d2685a38dacf891b36cea3449490108042a2163a263
+  metadata.gz: f7d27fb486170d53a80d6bf946672d2f71cb8e29ed2c292827452f35fb1c21789c6a894816d72dd959b5f06301d7c4da606440dbc6f1bd5c31a89ea8d3c51bf2
+  data.tar.gz: 144d996dd5e0bd9fbd8d73bdd0cfa70a5345371a85084b2fef7ea321f5964e710e0a870c366aacc83c02181135768b1548fb688987806e3a77f91505818763fb

data/README.md

@@ -1,17 +1,20 @@
 Birst_Command
 ====================
 
-Birst Command is a Ruby gem that allows you to build Ruby scripts that interface
-with the Birst Web API.
+Birst Command is a Ruby gem that allows you to build Ruby scripts that
+interface with the Birst Web API.
 
+Note: this is not an officially-sanctioned Birst project.  I'm just a
+Birst user that needed to set up a very basic Ruby interface.
 
 # Installation & Setup
 
 Install the gem using `gem install Birst_Command` or using rvm or
 rbenv/bundler as you prefer.
 
-After installing, you'll need to create a Birst Command config file that contains
-the credentials you'll use to connect to Birst.  This config file should look like,
+After installing, you'll need to create a Birst Command config file
+that contains the credentials you'll use to connect to Birst.  This
+config file should look like,
 
     {
         "wsdl": "https://login.bws.birst.com/CommandWebService.asmx?WSDL",
@@ -20,10 +23,10 @@ the credentials you'll use to connect to Birst.  This config file should look li
         "password": "obfuscated pwd"
     }
 
-Most users should only need to modify the username and password.  Since I have a strong
-aversion to storing passwords in plaintext, the password in the config file needs to
-be an obfuscated password.  Birst Command comes with a password obfuscator that can be
-executed via
+Most users should only need to modify the username and password.
+Since I have a strong aversion to storing passwords in plaintext, the
+password in the config file needs to be an obfuscated password.  Birst
+Command comes with a password obfuscator that can be executed via
 
     $ obfuscate_pwd.rb mypassword
     0x8GOZ5nA3oRSSS8ao1l6Q==
@@ -33,8 +36,32 @@ 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 also installs a rudimentary command line tool for interacting
+with the Birst web API.  It's still very simple.  If you want more functionality,
+please drop me a line in the github repository.
+
+To use the command line tool, put the config file created above in
+$HOME/.birstcl.  Then run Birst commands using `birstcl`.  You'll have to refer
+to the [Birst Documentation](https://app2102.bws.birst.com/CommandWebService.asmx)
+for a full list of commands.  All birst commands should be submitted using snake_case
+and arguments using the exact camelCase specified in the Birst documentation.  See
+below for an explanation of this bizarre requirement.  Here are some examples:
+
+List spaces
+
+    birstcl -c list_spaces
+
+Get list of sources for a space
+
+    birstcl -c get_sources_list -a '{ spaceID: "383nf0d7-3875-3829-3hff-faba8936180a" }'
+
+Copy space with options
+
+    birstcl -c copy_space -a '{ spFromID: "9ab9865c-37a8-0586-e856-ddd3856a0371", spToID: "3957a9b7-38c1-175v-3985-1957f1836a93", mode: "replicate", options: "data;repository;settings-basic" }'
+
+# Usage - As Ruby library
 
 In your Ruby program, include the Birst Command gem and load the config file via
 
@@ -44,9 +71,10 @@ In your Ruby program, include the Birst Command gem and load the config file via
 
     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 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
@@ -101,8 +129,8 @@ provides the basic interface.
 
 ## Command arguments
 
-Some Birst API commands require arguments.  All arguments are supplied as an argument
-hash.  For example, to create a new space,
+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",

data/bin/birstcl

@@ -0,0 +1,76 @@
+#!/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"
+
+module BirstCL
+  extend self
+
+  def set_options
+    @options = {}
+
+    OptionParser.new do |opts|
+      opts.banner = "Usage: birstcl -c <COMMAND> -a <ARGUMENTS>"
+
+      opts.on("--verbose", "--[no-]verbose", "Run verbosely") do |v|
+        @options[:verbose] = v
+      end
+
+      opts.on("-h","--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      @options[:command] = nil
+      opts.on("-c","--command <COMMAND>","COMMAND is the snake_case Birst web API command") do |opt|
+        @options[:command] = opt
+      end
+
+      @options[:arguments] = {}
+      opts.on("-a","--args <ARGUMNETS>","ARGUMENTS is a JSON string of arguments to COMMAND") do |opt|
+        @options[:arguments] = eval(opt)
+      end
+
+=begin
+      @options[:json_full_path] = nil
+      opts.on("-f","--file <JSON FILE>","Path to JSON file containing command") do |opt|
+        @options[:json_full_path] = opt
+      end
+=end
+
+      @options[:config_full_path] = "#{ENV['HOME']}/.birstcl"
+      opts.on("-s","--config_file <CONFIG FILE>", "Path to config file containing credentials (default: $HOME/.birstcl)") do |opt|
+        @options[:config_full_path] = opt
+      end
+    end.parse!
+  end
+
+
+  def read_config_file
+    Birst_Command::Config.read_config(@options[:config_full_path])
+  end
+
+
+  def execute_command
+    output = {}
+
+    output[:command] = @options[:command]
+    output[:arguments] = @options[:arguments]
+    Birst_Command::Session.start do |bc|
+      output[:token] = bc.token
+      output[:auth_cookies] = bc.auth_cookies.inspect
+      output[:result] = bc.send(@options[:command], @options[:arguments])
+    end
+    puts "#{JSON.pretty_generate output}"
+  end
+end
+
+BirstCL.set_options
+BirstCL.read_config_file
+BirstCL.execute_command

data/doc/roadmap.md

@@ -0,0 +1,7 @@
+# Birst Command Roadmap
+
+Some ideas
+
+* A standard helper library (for those ugly Birst response hashes)
+  built into the package that can optionally be loaded.
+* Code documentation using RDoc or some such thing

data/lib/birst_command/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Birst_Command
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sterling Paramore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -42,6 +42,7 @@ description: Ruby interface to Birst web API
 email:
 - gnilrets@gmail.com
 executables:
+- birstcl
 - obfuscate_pwd.rb
 extensions: []
 extra_rdoc_files: []
@@ -54,8 +55,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/birstcl
 - bin/obfuscate_pwd.rb
 - config.json_template
+- doc/roadmap.md
 - lib/birst_command.rb
 - lib/birst_command/config.rb
 - lib/birst_command/obfuscate.rb