Birst_Command 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3539b98b470dcf756fdf57c4fbd6ee4f9018dd91
-  data.tar.gz: 28f23d0c61e16552422fe7e8b4ac15ef3a6ddfc3
+  metadata.gz: bcdd92e145719837d3ed3e8852f5988dd67ce45f
+  data.tar.gz: d2da607de6a3b7b6464f2d75a3b184233f3bc06b
 SHA512:
-  metadata.gz: 4e1874a31e40343c3242df0829849b811874e1e8a1e90ad84a7866e4807f90d66c162ae053b18336bf880601e35e4d72381d69f204c7dacfe44761409b8e1602
-  data.tar.gz: 4d07c85ba378dfa0ec568b0bf3d204b7c67b146c1bb96af441a8aa2624fbcebdd30ba3588a22c700d061bc3c8cf0d7b7fb462a0ef026730d45dd3133510f0c8b
+  metadata.gz: a4b62531154a7185851a7063ca352c4f02b5699b7c971c776d66923564dfcf1df4cd207b1e057c499cf6623519cbf7a214d6f5a7134841d198acf084a3b7c330
+  data.tar.gz: 4450044f4856ed4ecfe05b59ba189926f8edf93cad684a3d38f9b5ab0ebbfb024579448a39bede084cb75843e98c3811163c2d1f676155ade18c5861253e8043

data/README.md

@@ -9,6 +9,8 @@ Birst user that needed to set up a very basic Ruby interface.
 
 # Installation & Setup
 
+Prerequisites: Ruby > 2.0 and rubygems.
+
 Install the gem using `gem install Birst_Command` or using rvm or
 rbenv/bundler as you prefer.
 
@@ -17,13 +19,15 @@ 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",
-        "endpoint": "https://login.bws.birst.com/CommandWebService.asmx",
+        "wsdl": "https://app2102.bws.birst.com/CommandWebService.asmx?WSDL",
+        "endpoint": "https://app2102.bws.birst.com/CommandWebService.asmx",
         "username": "name@myplace.com",
         "password": "obfuscated pwd"
     }
 
-Most users should only need to modify the username and password.
+Most users should only need to modify the username and
+password. (**Note**: do not use `login.bws.birst.com` since it does
+not use an updated WSDL; a specific app server must be specified).
 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
@@ -61,6 +65,24 @@ 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" }'
 
+## Cookies
+
+Many Birst web API commands return a job token that can be used to check up
+on the status of a job as it progresses.  The job tokens are tied to a specific
+server, and the only way to direct your login to a specific server is to use
+cookies.  So, if you wanted to copy a space with one command and then
+check whether the job is complete with another, you need to do something
+like the following.
+
+Copy a space and write a cookie file
+
+    birstcl -c copy_space -a '{ spFromID: "f9cb64fe-58a1-1db6-a7a8-9f091b4ea96f", spToID: "12913e53-3eac-4f98-91ab-2fqf345e22e5", mode: "replicate", options: "data;datastore;repository;useunloadfeature" }' -w ./cookie
+
+Note the job token returned as result and then run another command to
+check whether the job is complete by reading the cookie file
+
+    birstcl -c is_job_complete -a '{ jobToken: "9f636262f4c73d7503bf240ea08de040" }' -r ./cookie
+
 # Usage - As Ruby library
 
 In your Ruby program, include the Birst Command gem and load the config file via
@@ -108,6 +130,29 @@ The `spaces` variable is a Ruby hash parsed from the SOAP response.
 The structure of the returned hash follows the structure that Birst
 returns.
 
+## Cookies
+
+The start session block can also accept an argument named `use_cookie` to
+pass a cookie to be used during startup.  For example, suppose we start
+a copy job and save the `session_cookie` and `job_token` in variables.
+
+````ruby
+session_cookie = nil
+job_token = nil
+Session.start do |bc|
+  job_token = bc.copy_space :spFromID => @from_id, :spToID => @to_id, :mode => "replicate", :options => "data;datastore;useunloadfeature"
+  session_cookie = bc.auth_cookies
+end
+````
+In a subsequent session we can use the `session_cookie` on login via
+
+````ruby
+is_job_complete = false
+Session.start use_cookie: session_cookie do |bc|
+  is_job_complete = bc.is_job_complete :jobToken => job_token
+end
+puts "COMPLETE? #{is_job_complete}"
+````
 
 ## Helper methods
 
@@ -135,6 +180,7 @@ I have not included any of these helper methods in the Birst Command
 gem because what I find helpful, you may not.  Birst Command just
 provides the basic interface.
 
+
 ## Command arguments
 
 Some Birst API commands require arguments.  All arguments are supplied
@@ -142,9 +188,7 @@ as an argument hash.  For example, to create a new space,
 
 ````ruby
 Birst_Command::Session.start do |bc|
-  new_space_id = bc.create_new_space :spaceName => "myNewSpace",
-                                     :comments => "Just testing",
-                                     :automatic => "false"
+  new_space_id = bc.create_new_space :spaceName => "myNewSpace", :comments => "Just testing",:automatic => "false"
 end
 ````
 

data/bin/birstcl

@@ -47,6 +47,17 @@ module 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
+
+      @options[:write_cookie_full_path] = nil
+      opts.on("-w","--write_cookie_file <COOKIE FILE>", "Path to cookie file to write") do |opt|
+        @options[:write_cookie_full_path] = opt
+      end
+
+      @options[:read_cookie_full_path] = nil
+      opts.on("-r","--read_cookie_file <COOKIE FILE>", "Path to cookie file to read") do |opt|
+        @options[:read_cookie_full_path] = opt
+      end
+
     end.parse!
 
     if @options[:version]
@@ -61,17 +72,31 @@ module BirstCL
   end
 
 
+  def write_cookie_file(file_full_path)
+    return nil if file_full_path.nil?
+    File.open(file_full_path, 'w') {|f| f.write(Marshal.dump(@session_cookie)) }
+  end
+
+  def read_cookie_file(file_full_path)
+    return nil if file_full_path.nil?
+    Marshal.load(File.read(file_full_path))
+  end
+
+
   def execute_command
+    @session_cookie = read_cookie_file(@options[:read_cookie_full_path])
     output = {}
 
     output[:command] = @options[:command]
     output[:arguments] = @options[:arguments]
-    Birst_Command::Session.start do |bc|
+    Birst_Command::Session.start use_cookie: @session_cookie do |bc|
       output[:token] = bc.token
       output[:auth_cookies] = bc.auth_cookies.inspect
       output[:result] = bc.send(@options[:command], @options[:arguments])
+      @session_cookie = bc.auth_cookies
     end
     puts "#{JSON.pretty_generate output}"
+    write_cookie_file(@options[:write_cookie_full_path])
   end
 end
 

data/config.json_template

@@ -1,6 +1,6 @@
 {
-    "wsdl": "https://login.bws.birst.com/CommandWebService.asmx?WSDL",
-    "endpoint": "https://login.bws.birst.com/CommandWebService.asmx",
+    "wsdl": "https://app2102.bws.birst.com/CommandWebService.asmx?WSDL",
+    "endpoint": "https://app2102.bws.birst.com/CommandWebService.asmx",
     "username": "name@myplace.com",
     "password": "obfuscated pwd"
 }

data/lib/birst_command/session.rb

@@ -24,23 +24,25 @@ module Birst_Command
     attr_reader :response
 
 
-    def self.start(&b)
+    def self.start(use_cookie: nil, &b)
       session = self.new
-      session.login
+      session.login(use_cookie: use_cookie)
       session.execute_block(&b)
     ensure
       session.logout
     end
 
 
-    def login
+    def login(use_cookie: nil)
+      @auth_cookies = use_cookie
       @response = @client.call(:login,
+        cookies: @auth_cookies,
         message: {
           username: @options[:username], 
           password: Obfuscate.deobfuscate(@options[:password])
         })
 
-      @auth_cookies = @response.http.cookies
+      @auth_cookies = @response.http.cookies if @auth_cookies.nil?
       @token = @response.hash[:envelope][:body][:login_response][:login_result]      
     end
 

data/lib/birst_command/version.rb

@@ -1,3 +1,3 @@
 module Birst_Command
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/test/standard/test_cookie.rb

@@ -0,0 +1,61 @@
+require "test_birst_command"
+
+class Test_cookie < Test::Unit::TestCase
+
+  def setup
+    Birst_Command::Config.read_config
+    Birst_Command::Config.read_config(File.join(File.dirname(__FILE__),"../config_test.json"))
+    @new_space_id = nil
+  end
+
+  def teardown
+    Session.start do |bc|
+      bc.delete_space :spaceId => @new_space_id
+    end
+  end
+
+  def test_cookie_using_a_copy_command
+    test_options = Birst_Command::Config.options[:test][:test_copy_space]
+
+    session_cookie = nil
+    job_token = nil
+    Session.start do |bc|
+      @new_space_id = bc.create_new_space :spaceName => "test_copy_space",
+                                          :comments => "",
+                                          :automatic => "false"
+
+      puts "#{JSON.pretty_generate bc.list_spaces}"
+      job_token = bc.copy_space :spFromID => test_options[:from_space_id],
+                                :spToID => @new_space_id,
+                                :mode => "copy",
+                                :options => "data;settings-permissions;settings-membership;repository;birst-connect;custom-subject-areas;dashboardstyles;salesforce;catalog;CustomGeoMaps.xml;spacesettings.xml;SavedExpressions.xml;DrillMaps.xml;connectors;datastore-aggregates;settings-basic"
+
+      session_cookie = bc.auth_cookies
+    end
+
+    puts "COOKIE COOKIE: #{session_cookie}"
+
+    i = 0
+    loop do
+      i += 1
+      if i < 60
+        is_job_complete = false
+        Session.start use_cookie: session_cookie do |bc|
+          is_job_complete = bc.is_job_complete :jobToken => job_token
+        end
+        puts "COMPLETE? #{is_job_complete}"
+
+        sleep 1
+        break if is_job_complete
+      else
+        raise "Copy job timed out"
+      end
+
+    end
+
+
+    # This test sucks, but it will fail if the cookies don't work
+    assert_equal 36, @new_space_id.length, "Got an invalid space id #{@new_space_id}"
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Birst_Command
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sterling Paramore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -69,6 +69,7 @@ files:
 - test/standard/resources/config_test.json
 - test/standard/test_add_user_to_space.rb
 - test/standard/test_command_helper.rb
+- test/standard/test_cookie.rb
 - test/standard/test_copy_space.rb
 - test/standard/test_deobfuscate.rb
 - test/standard/test_list_spaces.rb
@@ -104,6 +105,7 @@ test_files:
 - test/standard/resources/config_test.json
 - test/standard/test_add_user_to_space.rb
 - test/standard/test_command_helper.rb
+- test/standard/test_cookie.rb
 - test/standard/test_copy_space.rb
 - test/standard/test_deobfuscate.rb
 - test/standard/test_list_spaces.rb