socialcast 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 059c8d71c405b6bd225ddf6bcadd22c55448c244
-  data.tar.gz: 73dc16b3f63221865f07dd46c74f992d0f8ae96a
+  metadata.gz: 788cbe26a9ad449b6b0a366c6d264069586e4653
+  data.tar.gz: 1f21d4c2e36ed4ab2e8809ae8d0aea2d7e38b943
 SHA512:
-  metadata.gz: 49c4a5675ab1f9832d56aa7ee23678977424020cd002573c72183f1842f6a72adb23ffb1a18464720abcdaf42da17ea5594545866f59174cf86c4746332c1cff
-  data.tar.gz: 9ca90bb330803ed0dae3fe8ae78b86fccdb1c86c934ed43bf3497c41e455ba494f740abecba293132496149ad6d4eaf292b9d90586239cb7909d90769919b635
+  metadata.gz: 90c71da04a539297455463f1b7f81f9b3737c957dd5882acc9539ed52a19f2f43315fcede8e96e38a6b8ce818c91d655d26134e87995715b1444b647e326c777
+  data.tar.gz: 7a254b2b4132c6144a58a2d026e8aede0cae18c7a39c4f63c1f680e324578ddd2789c7f099f5cd5308297a56efa60ddfbe50e526d5189449b71afcc8b25a3f98

data/lib/socialcast.rb

@@ -3,6 +3,7 @@ require 'fileutils'
 
 require_relative 'socialcast/command_line/ldap_connector'
 require_relative 'socialcast/command_line/provision'
+require_relative 'socialcast/command_line/authenticate'
 require_relative 'socialcast/command_line/message'
 require_relative 'socialcast/command_line/cli'
 require_relative 'socialcast/command_line/version'
@@ -25,8 +26,10 @@ module Socialcast
     end
 
     def self.credentials=(options)
-      File.open(credentials_file, "w") do |f|
-        f.write(options.to_yaml)
+      File.open(credentials_file, "a+") do |f|
+        existing_content = YAML.load(f.read) || {}
+        f.truncate(0)
+        f.write(existing_content.merge(options).to_yaml)
       end
       File.chmod 0600, credentials_file
     end
@@ -36,7 +39,15 @@ module Socialcast
       RestClient.log = Logger.new(STDOUT) if debug
       RestClient.proxy = credentials[:proxy] if credentials[:proxy]
       url = ['https://', credentials[:domain], path].join
-      RestClient::Resource.new url, options.merge({ :user => credentials[:user], :password => credentials[:password] })
+      RestClient::Resource.new url, options.merge(authentication(options))
+    end
+
+    def self.authentication(options)
+      if options[:external_system]
+        { :headers => { :Authorization => "SocialcastApiClient #{credentials[:api_client_identifier]}:#{credentials[:api_client_secret]}" } }
+      else
+        { :user => credentials[:user], :password => credentials[:password] }
+      end
     end
 
   end

data/lib/socialcast/command_line/authenticate.rb

@@ -0,0 +1,46 @@
+module Socialcast
+  module CommandLine
+    class Authenticate
+      attr_accessor :authenticate_type, :options, :params, :headers
+
+      def initialize(authenticate_type, options, params, headers = {})
+        self.authenticate_type = authenticate_type
+        self.options = options
+        self.params = params
+        self.headers = headers
+      end
+
+      def request
+        @request ||= send_request
+      end
+
+      private
+
+      def send_request
+        puts "Authenticating to #{url}"
+        RestClient.log = Logger.new($stdout) if options[:trace]
+        RestClient.proxy = options[:proxy] if options[:proxy]
+        resource = RestClient::Resource.new url, headers
+        response = resource.post params, :accept => :json
+        puts "API response: #{response.body.to_s}" if options[:trace]
+        set_default_credentials
+        response
+      end
+
+      def set_default_credentials
+        Socialcast::CommandLine.credentials = {
+          :domain => domain,
+          :proxy => options[:proxy]
+        }
+      end
+
+      def url
+        @url ||= File.join("https://", domain, 'api', (authenticate_type == :external_system ? 'external_systems/' : ''), 'authentication')
+      end
+
+      def domain
+        options[:domain]
+      end
+    end
+  end
+end

data/lib/socialcast/command_line/cli.rb

@@ -49,23 +49,43 @@ module Socialcast
       def authenticate
         user = options[:user] || ask('Socialcast username: ')
         password = options[:password] || HighLine.new.ask("Socialcast password: ") { |q| q.echo = false }.to_s
-        domain = options[:domain]
 
-        url = ['https://', domain, '/api/authentication'].join
-        say "Authenticating #{user} to #{url}"
         params = { :email => user, :password => password }
-        RestClient.log = Logger.new(STDOUT) if options[:trace]
-        RestClient.proxy = options[:proxy] if options[:proxy]
-        resource = RestClient::Resource.new url
-        response = resource.post params, :accept => :json
-        say "API response: #{response.body.to_s}" if options[:trace]
+        response = Socialcast::CommandLine::Authenticate.new(:user, options, params).request
         communities = JSON.parse(response.body.to_s)['communities']
         domain = communities.detect {|c| c['domain'] == domain} ? domain : communities.first['domain']
 
-        Socialcast::CommandLine.credentials = {:user => user, :password => password, :domain => domain, :proxy => options[:proxy]}
+        Socialcast::CommandLine.credentials = {
+          :user => user,
+          :password => password,
+          :domain => domain
+        }
         say "Authentication successful for #{domain}"
       end
 
+      desc "authenticate_external_system", "Authenticate using an external system"
+      method_option :api_client_identifier, :type => :string, :aliases => '-i', :desc => 'the identifier of the external system'
+      method_option :api_client_secret, :type => :string, :aliases => '-s', :desc => 'the secret key of the external system'
+      method_option :proxy, :type => :string, :desc => 'HTTP proxy options for connecting to Socialcast server'
+      method_option :domain, :type => :string, :default => 'api.socialcast.com', :desc => 'Socialcast community domain'
+      def authenticate_external_system
+        api_client_identifier = options[:api_client_identifier] || ask("Socialcast external system identifier: ")
+        api_client_secret = options[:api_client_secret] || ask("Socialcast external system API secret: ")
+
+        headers = {
+          :headers => {
+            :Authorization => "SocialcastApiClient #{api_client_identifier}:#{api_client_secret}"
+          }
+        }
+
+        Socialcast::CommandLine::Authenticate.new(:external_system, options, {}, headers).request
+
+        Socialcast::CommandLine.credentials = {
+          :api_client_identifier => api_client_identifier,
+          :api_client_secret => api_client_secret,
+        }
+      end
+
       desc "share MESSAGE", "Posts a new message into socialcast"
       method_option :url, :type => :string, :desc => '(optional) url to associate to the message'
       method_option :message_type, :type => :string, :desc => '(optional) force an alternate message_type'
@@ -105,6 +125,7 @@ module Socialcast
       method_option :skip_emails, :type => :boolean, :desc => 'Do not send signup emails to users'
       method_option :force, :type => :boolean, :aliases => '-f', :default => false, :desc => 'Proceed with provisioning even if no users are found, which would deactivate all users in the community'
       method_option :plugins, :type => :array, :desc => "Pass in an array of plugins. Can be either the gem require or the absolute path to a ruby file"
+      method_option :external_system, :type => :boolean, :desc => "Use an external system for authentication purposes"
       def provision
         config = ldap_config options
         load_plugins options

data/lib/socialcast/command_line/provision.rb

@@ -34,7 +34,7 @@ module Socialcast
       end
 
       def provision
-        http_config = @ldap_config.fetch 'http', {}
+        params = @ldap_config.fetch('http', {}).merge(:external_system => !!@options[:external_system])
 
         user_whitelist = Set.new
         output_file = File.join Dir.pwd, @options[:output]
@@ -56,7 +56,7 @@ module Socialcast
           raise ProvisionError.new "Skipping upload to Socialcast since no users were found"
         else
           puts "Uploading dataset to Socialcast..."
-          resource = Socialcast::CommandLine.resource_for_path '/api/users/provision', http_config
+          resource = Socialcast::CommandLine.resource_for_path '/api/users/provision', params
           begin
             File.open(output_file, 'r') do |file|
               request_params = {:file => file}
@@ -65,7 +65,9 @@ module Socialcast
               resource.post request_params, :accept => :json
             end
           rescue RestClient::Unauthorized => e
-            raise ProvisionError.new "Authenticated user either does not have administration privileges or the community is not configured to allow provisioning. Please contact Socialcast support to if you need help." if e.http_code == 401
+            error_message = @options[:external_system] ? "External Provisioning System was not found." : "Authenticated user either does not have administration privileges or the community is not configured to allow provisioning."
+            contact_message = "Please contact Socialcast support to if you need help."
+            raise ProvisionError.new "#{error_message} #{contact_message}\nResponse from server: #{e.response.body}" if e.http_code == 401
           end
           puts "Finished"
         end

data/lib/socialcast/command_line/version.rb

@@ -1,5 +1,5 @@
 module Socialcast
   module CommandLine
-    VERSION = "1.3.6"
+    VERSION = "1.3.7"
   end
 end

data/spec/fixtures/credentials.yml

@@ -1,4 +1,6 @@
 ---
 :user: ryan@socialcast.com
 :password: foo
+:api_client_identifier: my_id
+:api_client_secret: mysecret
 :domain: test.staging.socialcast.com

data/spec/socialcast/command_line/authenticate_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Socialcast::CommandLine::Authenticate do
+  let(:options) { { :domain => "test.socialcast.local" } }
+  let(:params) { {  } }
+  subject { Socialcast::CommandLine::Authenticate.new(authenticate_type, options, params) }
+
+  describe '#request' do
+    before do
+      RestClient::Resource.should_receive(:new).with(url, {}).and_call_original
+      RestClient::Resource.any_instance.should_receive(:post).with(subject.params, :accept => :json)
+      subject.request
+    end
+    context 'for a regular user' do
+      let(:authenticate_type) { :user }
+      let(:url) { "https://test.socialcast.local/api/authentication" }
+      # See expectations
+      it 'hits the API to try authentication for a regular user' do end
+    end
+
+    context 'for an external system' do
+      let(:url) { "https://test.socialcast.local/api/external_systems/authentication" }
+      let(:authenticate_type) { :external_system }
+      # See expectations
+      it 'hits the API to try authentication for an external system' do end
+    end
+  end
+
+end

data/spec/socialcast/command_line/cli_spec.rb

@@ -34,6 +34,51 @@ describe Socialcast::CommandLine::CLI do
     end
   end
 
+  describe '#authenticate' do
+    let(:user) { 'mike@socialcast.com' }
+    let(:password) { 'password' }
+    let(:domain) { 'api.socialcast.com' }
+    before do
+      Socialcast::CommandLine.should_receive(:credentials=).with({
+        :domain => 'api.socialcast.com',
+        :proxy => nil
+      })
+      Socialcast::CommandLine.should_receive(:credentials=).with({
+        :user => user,
+        :password => password,
+        :domain => domain
+      })
+      stub_request(:post, "https://api.socialcast.com/api/authentication").
+         with(:body => {"email"=>"mike@socialcast.com", "password"=>"password"}).
+         to_return(:status => 200, :body => { :communities => [{ :domain => domain }] }.to_json, :headers => {})
+      Socialcast::CommandLine::CLI.start ['authenticate', "--user=#{user}", "--password=#{password}"]
+    end
+    ## See expectations
+    it 'authenticates with the API and sets the given credentials' do end
+  end
+
+  describe '#authenticate_external_system' do
+    let(:api_client_identifier) { 'my-client-id' }
+    let(:api_client_secret) { 'my-client-secret' }
+    let(:domain) { 'api.socialcast.com' }
+    before do
+      Socialcast::CommandLine.should_receive(:credentials=).with({
+        :domain => 'api.socialcast.com',
+        :proxy => nil
+      })
+      Socialcast::CommandLine.should_receive(:credentials=).with({
+        :api_client_identifier => api_client_identifier,
+        :api_client_secret => api_client_secret,
+      })
+      stub_request(:post, "https://api.socialcast.com/api/external_systems/authentication").
+         with(:headers => {'Authorization'=>'SocialcastApiClient my-client-id:my-client-secret'}).
+         to_return(:status => 200, :body => "", :headers => {})
+      Socialcast::CommandLine::CLI.start ['authenticate_external_system', "--api_client_identifier=#{api_client_identifier}", "--api_client_secret=#{api_client_secret}"]
+    end
+    ## See expectations
+    it 'authenticates with the API and sets the given credentials for an authenticated system' do end
+  end
+
   describe '#share' do
     # Expects -u=emily@socialcast.com -p=demo --domain=demo.socialcast.com
     context 'with a basic message' do
@@ -252,9 +297,9 @@ describe Socialcast::CommandLine::CLI do
 
         File.stub(:open).with(/users.xml.gz/, anything).and_yield(@result)
         rest_client_resource = double(:rest_client_resource)
-        rest_client_resource.stub(:post).and_raise(RestClient::Unauthorized.new(mock('Unauthorized HTTP Response', :code => '401')))
+        rest_client_resource.stub(:post).and_raise(RestClient::Unauthorized.new(double('Unauthorized HTTP Response', :code => '401', :body => 'Unauthorized HTTP Response')))
         Socialcast::CommandLine.stub(:resource_for_path).and_return(rest_client_resource)
-        Kernel.should_receive(:abort).with("Authenticated user either does not have administration privileges or the community is not configured to allow provisioning. Please contact Socialcast support to if you need help.").once
+        Kernel.should_receive(:abort).with("Authenticated user either does not have administration privileges or the community is not configured to allow provisioning. Please contact Socialcast support to if you need help.\nResponse from server: Unauthorized HTTP Response").once
 
         Socialcast::CommandLine::CLI.start ['provision', '-f']
       end

data/spec/socialcast/socialcast_spec.rb

@@ -5,8 +5,9 @@ describe Socialcast::CommandLine do
   let(:custom_file) { File.join(File.dirname(__FILE__), '..', 'fixtures', 'custom_credentials.yml') }
   let(:stubbed_credentials) { File.join(File.dirname(__FILE__), '..', 'fixtures') }
   before { Socialcast::CommandLine.stub(:config_dir).and_return(stubbed_credentials) }
+  let!(:orig_credentials) { Socialcast::CommandLine.credentials }
 
-  describe '#credentials_file' do
+  describe '.credentials_file' do
     subject { Socialcast::CommandLine.credentials_file }
     context 'with ENV variable' do
       before { ENV['SC_CREDENTIALS_FILE'] = custom_file }
@@ -18,7 +19,7 @@ describe Socialcast::CommandLine do
     end
   end
 
-  describe '#credentials' do
+  describe '.credentials' do
     subject { Socialcast::CommandLine.credentials }
     describe 'with ENV variable' do
       before { ENV['SC_CREDENTIALS_FILE'] = custom_file }
@@ -30,4 +31,35 @@ describe Socialcast::CommandLine do
     end
   end
 
+  describe '.credentials=' do
+    let(:options) { { :user => 'mike@socialcast.com', :password => 'mypassword' } }
+    before { Socialcast::CommandLine.credentials = options }
+    after { Socialcast::CommandLine.credentials = orig_credentials }
+    subject { Socialcast::CommandLine.credentials }
+    context 'modifies the credentials file with the options content' do
+      it { subject[:user].should == 'mike@socialcast.com' }
+    end
+    context 'only changes the content provided' do
+      let(:options) { { :api_client_secret => 'mysecret', :api_client_identifier => 'my_id' } }
+      it { subject[:api_client_identifier].should == 'my_id' }
+      it { subject[:user].should == 'ryan@socialcast.com' }
+    end
+  end
+
+  describe '.resource_for_path' do
+    let(:path) { '/mypath' }
+    let(:url) { "https://test.staging.socialcast.com#{path}" }
+    before do
+      RestClient::Resource.should_receive(:new).with(url, options)
+      Socialcast::CommandLine.resource_for_path(path, options)
+    end
+    context 'when using basic auth' do
+      let(:options) { { :user => Socialcast::CommandLine.credentials[:user], :password => Socialcast::CommandLine.credentials[:password] } }
+      it 'sends user email and password' do end
+    end
+    context 'when using an external system' do
+      let(:options) { { :external_system => true, :headers => { :Authorization=>"SocialcastApiClient my_id:mysecret" } } }
+      it 'sends external system credentials' do end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socialcast
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.3.7
 platform: ruby
 authors:
 - Ryan Sonnek
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -217,6 +217,7 @@ files:
 - bin/socialcast
 - config/ldap.yml
 - lib/socialcast.rb
+- lib/socialcast/command_line/authenticate.rb
 - lib/socialcast/command_line/cli.rb
 - lib/socialcast/command_line/ldap_connector.rb
 - lib/socialcast/command_line/message.rb
@@ -244,6 +245,7 @@ files:
 - spec/fixtures/ldap_with_unique_identifier.yml
 - spec/fixtures/ldap_without_account_type_or_roles.yml
 - spec/fixtures/ldap_without_permission_mappings.yml
+- spec/socialcast/command_line/authenticate_spec.rb
 - spec/socialcast/command_line/cli_spec.rb
 - spec/socialcast/command_line/ldap_connector_spec.rb
 - spec/socialcast/command_line/provision_spec.rb
@@ -295,6 +297,7 @@ test_files:
 - spec/fixtures/ldap_with_unique_identifier.yml
 - spec/fixtures/ldap_without_account_type_or_roles.yml
 - spec/fixtures/ldap_without_permission_mappings.yml
+- spec/socialcast/command_line/authenticate_spec.rb
 - spec/socialcast/command_line/cli_spec.rb
 - spec/socialcast/command_line/ldap_connector_spec.rb
 - spec/socialcast/command_line/provision_spec.rb