Birst_Command 0.5.0 → 0.6.0

data/lib/birst_command/settings.rb

@@ -0,0 +1,26 @@
+module Birst_Command
+
+  # Public: Configatron instance used to set default options for Birst_Connect
+  Settings = Configatron::Store.new
+
+  def self.load_default_settings
+    # Default settings applied to all sessions (can be overridden in specific session)
+    Settings.session do |session|
+      session.wsdl           = "https://app2101.bws.birst.com/CommandWebService.asmx?WSDL"
+      session.endpoint       = "https://app2101.bws.birst.com/CommandWebService.asmx"
+      session.username       = ENV['BIRST_USER'] || "BIRST_USER"
+      session.password       = ENV['BIRST_PWD'] || "BIRST_PWD"
+      session.soap_log       = true
+      session.soap_log_level = :error
+      session.soap_logger    = Logger.new(STDOUT)
+    end
+  end
+  load_default_settings
+
+  def self.load_settings_from_file(file)
+    parse_erb = ERB.new(IO.read(file)).result(binding)
+    settings = YAML.load(parse_erb).symbolize_keys
+    Settings.configure_from_hash(settings)
+  end
+
+end

data/lib/birst_command/version.rb

@@ -1,3 +1,3 @@
 module Birst_Command
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/bc_spec_fixtures.rb

@@ -0,0 +1,70 @@
+module BCSpecFixtures
+  class << self
+
+    def login_token
+      "46a87e10b37e21653186ffe0973f54ae"
+    end
+
+    def login
+      <<-EOT.unindent
+      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+        <soap:Body>
+          <LoginResponse xmlns="http://www.birst.com/">
+            <LoginResult>#{login_token}</LoginResult>
+          </LoginResponse>
+        </soap:Body>
+      </soap:Envelope>
+      EOT
+    end
+
+    def logout
+      <<-EOT.unindent
+      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+        <soap:Body>
+          <LogoutResponse xmlns="http://www.birst.com/"/>
+        </soap:Body>
+      </soap:Envelope>
+      EOT
+    end
+    
+    def list_spaces
+      <<-EOT.unindent
+      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+        <soap:Body>
+          <listSpacesResponse xmlns="http://www.birst.com/">
+            <listSpacesResult>
+              <UserSpace>
+                <name>My_First_Space</name>
+                <owner>user@example.com</owner>
+                <id>b016c5c7-00ad-413a-a058-db78edef2961</id>
+              </UserSpace>
+              <UserSpace>
+                <name>My_Second_Space</name>
+                <owner>user@example.com</owner>
+                <id>b7f3df39-438c-4ec7-bd29-489f41afde14</id>
+              </UserSpace>
+            </listSpacesResult>
+          </listSpacesResponse>
+        </soap:Body>
+      </soap:Envelope>
+      EOT
+    end
+
+    def list_users_in_space
+      <<-EOT.unindent
+      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+        <soap:Body>
+          <listUsersInSpaceResponse xmlns="http://www.birst.com/">
+            <listUsersInSpaceResult>
+              <string>user@example.com</string>
+              <string>myname@example.com</string>
+              <string>coolbeans@example.com</string>
+            </listUsersInSpaceResult>
+          </listUsersInSpaceResponse>
+        </soap:Body>
+      </soap:Envelope>
+      EOT
+    end
+
+  end
+end

data/spec/birst_command_spec.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH << '../lib'
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'birst_command'
+require 'savon/mock/spec_helper'
+require 'session_spec_helper'
+require_relative 'bc_spec_fixtures'
+
+include Birst_Command
+include Savon::SpecHelper
+include SessionSpecHelper

data/spec/cookie_spec.rb

@@ -0,0 +1,74 @@
+# Unfortunately, Savon cannot mock cookies.  So we'll have to run it live.
+describe "Cookie handling" do
+  before { Settings.session.soap_log_level = :debug }
+
+  # Create a new space
+  let(:session_vars) do
+    space_id = nil
+    cookie = nil
+    Session.new do |bc|
+      space_id = bc.create_new_space(
+        :spaceName => "Birst_Command-Spec-#{SecureRandom.hex(4)}",
+        :comments => "",
+        :automatic => "false"
+      )
+      cookie = bc.auth_cookie
+    end
+    { :space_id => space_id, :cookie => cookie }
+  end
+
+  # Set the space id and cookie separately
+  [:space_id, :cookie].each do |var|
+    let(var) { session_vars[var] }
+  end
+
+  # Example data chunk to upload
+  let(:data_chunk) do
+    <<-EOT.unindent
+    category,value
+    A,1
+    B,2
+    C,3
+    D,4
+    E,5
+    EOT
+  end
+
+
+  # Cleanup created spaces
+  after do
+    Session.new do |bc|
+      bc.delete_space :spaceId => space_id
+    end
+  end
+
+
+  # This test doesn't always fail if there is a cookie problem, so test it 5 times
+  1.upto(5).each do
+    specify "cookie should enforce login environment" do
+      upload_token = nil
+      Session.new auth_cookie: cookie do |bc|
+        upload_token = bc.begin_data_upload(:spaceID => space_id, 
+                                            :sourceName => "MyTestData"
+                                           )
+      end
+
+      Session.new auth_cookie: cookie, soap_log_level: :error do |bc|
+        bc.upload_data(:dataUploadToken => upload_token,
+                       :numBytes => data_chunk.bytesize,
+                       :data => Base64.encode64(data_chunk)
+                       )
+      end
+
+      Session.new auth_cookie: cookie do |bc|
+        bc.finish_data_upload(:dataUploadToken => upload_token)
+      end
+
+      Session.new auth_cookie: cookie do |bc|
+        upload_complete = bc.is_data_upload_complete(:dataUploadToken => upload_token)
+        puts "UPLOAD COMPLETE? #{upload_complete}"
+      end
+
+    end
+  end
+end

data/spec/sample_settings.yaml

@@ -0,0 +1,9 @@
+---
+
+session:
+  wsdl: "https://app2101.bws.birst.com/CommandWebService.asmx?WSDL"
+  endpoint: "https://app2101.bws.birst.com/CommandWebService.asmx"
+  username: "ThisIsntARealUsername"
+  password: "<%= ENV['BC_SPEC_PASSWORD'] %>"
+  soap_log: true
+  soap_log_level: :error

data/spec/session_spec.rb

@@ -0,0 +1,101 @@
+describe "Sessions" do
+  before { Settings.session.soap_log_level = :debug }
+
+  shared_examples_for "Log in and out" do
+
+    context "by calling the object methods directly" do
+      specify "without options" do
+        mysession = Session.new
+        expect(mysession.login).to be_successful
+        mysession.logout
+      end
+
+      specify "with options" do
+        mysession = Session.new :soap_log_level => :error, :soap_logger => Logger.new(STDOUT)
+        expect(mysession.login).to be_successful
+        mysession.logout
+      end
+    end
+
+    context "in a session block" do
+      specify "without options" do
+        Session.new do |bc|
+        end
+      end
+
+      specify "with options" do
+        Session.new :soap_log_level => :error, :soap_logger => Logger.new(STDOUT) do |bc|
+        end
+      end
+    end
+  end
+
+
+  shared_examples_for "list spaces" do
+    describe "list spaces" do
+      it "should list spaces" do
+        spaces = nil
+        Session.new do |bc|
+          spaces = bc.list_spaces
+        end
+
+        expect(spaces[:user_space].length).to be > 0
+      end
+    end
+  end
+
+  shared_examples_for "list users in space" do
+    describe "list users in space" do
+      it "should list the users in the space" do
+        users = nil
+        Session.new do |bc|
+          users = bc.list_users_in_space :spaceID => spaceID
+        end
+
+        expect(users[:string].length).to be > 0
+      end
+    end
+  end
+
+
+
+  context "with mock objects" do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    context "mock log in and out" do
+      before { mock_login_and_out }
+      it_behaves_like "Log in and out"
+    end
+
+    context "mock list spaces" do
+      before do
+        mock_login_and_out { savon.expects(:list_spaces).with(message: { :token => BCSpecFixtures.login_token }).returns(BCSpecFixtures.list_spaces) }
+      end
+      it_behaves_like "list spaces"
+    end
+
+    context "mock list users in spaces" do
+      let(:spaceID) { "b7f3df39-438c-4ec7-bd29-489f41afde14" }
+      before do
+        message = { :token => BCSpecFixtures.login_token, :spaceID => spaceID }
+        mock_login_and_out { savon.expects(:list_users_in_space).with(message: message).returns(BCSpecFixtures.list_users_in_space) }
+      end
+      it_behaves_like "list users in space"
+    end
+  end
+
+  context "with live connection to BWS", :live => true do
+    it_behaves_like "Log in and out"
+    it_behaves_like "list spaces"
+
+    let(:spaceID) do
+      spaces = nil
+      Session.new { |bc| spaces = bc.list_spaces }
+      spaces[:user_space][0][:id]
+    end
+    it_behaves_like "list users in space"
+  end
+
+end

data/spec/session_spec_helper.rb

@@ -0,0 +1,10 @@
+module SessionSpecHelper
+  def mock_login_and_out(&block)
+    crypt = Envcrypt::Envcrypter.new
+
+    message = { :username => Settings.session.username, :password => crypt.decrypt(Settings.session.password) }
+    savon.expects(:login).with(message: message).returns(BCSpecFixtures.login)
+    yield if block_given?
+    savon.expects(:logout).with(message: { :token => BCSpecFixtures.login_token }).returns(BCSpecFixtures.logout)
+  end
+end

data/spec/settings_spec.rb

@@ -0,0 +1,19 @@
+describe "Loading settings from YAML file" do
+
+  let(:test_password) { "Habedashery==" }
+
+  before do
+    ENV['BC_SPEC_PASSWORD'] = test_password
+
+    file = File.join(File.dirname(__FILE__),"sample_settings.yaml")
+    Birst_Command.load_settings_from_file(file)
+  end
+
+  it "should set the username from the file" do
+    expect(Settings.session.username).to eq "ThisIsntARealUsername"
+  end
+
+  it "should use ERB to set the password" do
+    expect(Settings.session.password).to eq test_password
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Birst_Command
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Sterling Paramore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: configatron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Ruby interface to Birst web API
 email:
 - gnilrets@gmail.com
@@ -62,32 +76,29 @@ extra_rdoc_files: []
 files:
 - .bundle/config
 - .gitignore
+- .rspec
 - .ruby-version
 - Birst_Command.gemspec
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/birstcl
-- config.json_template
 - doc/roadmap.md
 - lib/birst_command.rb
-- lib/birst_command/config.rb
 - lib/birst_command/core_additions.rb
 - lib/birst_command/session.rb
+- lib/birst_command/settings.rb
 - lib/birst_command/version.rb
-- test/.gitignore
-- test/config_test.json_template
-- 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_list_spaces.rb
-- test/standard/test_login.rb
-- test/standard/test_password.rb
-- test/standard/test_read_config.rb
-- test/test_birst_command.rb
+- spec/bc_spec_fixtures.rb
+- spec/birst_command_spec.rb
+- spec/cookie_spec.rb
+- spec/sample_settings.yaml
+- spec/session_spec.rb
+- spec/session_spec_helper.rb
+- spec/settings_spec.rb
 homepage: https://github.com/gnilrets
 licenses:
 - MIT
@@ -108,19 +119,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: Birst_Command
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Birst Command
 test_files:
-- test/config_test.json_template
-- 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_list_spaces.rb
-- test/standard/test_login.rb
-- test/standard/test_password.rb
-- test/standard/test_read_config.rb
-- test/test_birst_command.rb
+- spec/bc_spec_fixtures.rb
+- spec/birst_command_spec.rb
+- spec/cookie_spec.rb
+- spec/sample_settings.yaml
+- spec/session_spec.rb
+- spec/session_spec_helper.rb
+- spec/settings_spec.rb