spark_api 1.1.2 → 1.2.0

data/script/oauth2_example.rb

@@ -15,8 +15,8 @@ SparkApi.configure do |config|
   config.api_secret   = "YOUR_CLIENT_SECRET"
   config.callback     = "YOUR_REDIRECT_URI"
   config.version      = "v1"
-  config.endpoint     = "https://developers.sparkapi.com"
-  config.auth_endpoint = "https://developers.sparkplatform.com/oauth2"
+  config.endpoint     = "https://sparkapi.com"
+  config.auth_endpoint = "https://sparkplatform.com/oauth2"
 end
 
 client = SparkApi.client
@@ -25,7 +25,7 @@ client = SparkApi.client
 # Step 1:
 # To get your code to post to /v1/oauth2/grant, send the end user to this URI, replacing the all-capped strings with
 # the CGI-escaped credentials for your key:
-# https://developers.sparkplatform.com/oauth2?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI
+# https://sparkplatform.com/oauth2?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI
 # When the user has finished, they will land at:
 # YOUR_REDIRECT_URI?code=CODE.
 puts "Go here and log in to get your code: #{client.authenticator.authorization_url}"

data/spec/fixtures/base.json

@@ -2,12 +2,14 @@
             "Success": true, 
             "Results": [{
               "Id": 1,
+              "ResourceUri": "some/place/123",
               "Name": "My Example", 
               "Test": true
             },
             {
               "Id": 2, 
+              "ResourceUri": "some/place/123",
               "Name": "My Example2", 
               "Test": false
             }]}
-            }
+            }

data/spec/fixtures/contacts/new.json

@@ -5,7 +5,6 @@
 				"DisplayName": "Contact Four",
 				"PrimaryEmail": "contact4@fbsdata.com"
 			}
-		],
-		"Notify": false
+		]
 	}
-}
+}

data/spec/fixtures/contacts/new_empty.json

@@ -2,7 +2,6 @@
 	"D": {
 		"Contacts": [
 			{ }
-		],
-		"Notify": false
+		]
 	}
-}
+}

data/spec/fixtures/contacts/new_notify.json

@@ -8,4 +8,4 @@
 		],
 		"Notify": true
 	}
-}
+}

data/spec/fixtures/{listings/saved_search.json → saved_searches/get.json}

@@ -14,4 +14,4 @@
             }
         ]
     }
-}
+}

data/spec/fixtures/saved_searches/new.json

@@ -0,0 +1,8 @@
+{
+	"D": {
+        "SavedSearches": [
+            { "Name": "A new search name here" }
+        ]
+	}
+}
+

data/spec/fixtures/saved_searches/post.json

@@ -0,0 +1,12 @@
+{
+    "D": {
+        "Success": true,
+		"Results": [
+			{
+              "ResourceUri": "/v1/savedsearches/20100815220615294367000000",
+              "Id":  "20100815220615294367000000",
+              "Name": "A new search name here" 
+			}
+        ]
+    }
+}

data/spec/fixtures/saved_searches/update.json

@@ -0,0 +1,6 @@
+{
+	"D": {
+        "Name": "A new search name here" 
+	}
+}
+

data/spec/fixtures/subscriptions/get.json

@@ -0,0 +1,19 @@
+{
+	"D": {
+		"Success": true, 
+		"Results": [
+			{
+                "Id":"20101230223226074204000000",
+				"ResourceUri":"/v1/contacts/20101230223226074204000000",
+                "Name":"First subscription",
+                "RecipientIds": ["20101230223226074307000000"]
+			},
+			{
+                "Id":"20101230223226074205000000",
+				"ResourceUri":"/v1/contacts/20101230223226074205000000",
+                "Name":"Second subscription",
+                "RecipientIds": []
+			}
+		]
+	}
+}

data/spec/fixtures/subscriptions/new.json

@@ -0,0 +1,13 @@
+{
+	"D": {
+        "Subscriptions": [
+            {
+                "Name":"A new subscription name",
+                "SearchId":"20101230223226074204000000",
+                "RecipientIds": ["20101230223226074204000000"],
+                "Subject": "my subject",
+                "Message": "my message"
+            }
+        ]
+	}
+}

data/spec/fixtures/subscriptions/post.json

@@ -0,0 +1,10 @@
+{
+	"D": {
+		"Success": true, 
+		"Results": [
+			{
+				"ResourceUri":"/v1/subscriptions/20101230223226074204000000"
+			}
+		]
+	}
+}

data/spec/fixtures/subscriptions/put.json

@@ -0,0 +1,12 @@
+{
+	"D": {
+		"Success": true, 
+		"Results": [
+			{
+                "Id":"20101230223226074204000000",
+				"ResourceUri":"/v1/contacts/20101230223226074204000000",
+                "Name":"A new subscription name"
+			}
+		]
+	}
+}

data/spec/fixtures/subscriptions/subscribe.json

@@ -0,0 +1,5 @@
+{
+    "D":{
+        "Success":true
+    }
+}

data/spec/fixtures/subscriptions/update.json

@@ -0,0 +1,6 @@
+{
+	"D": {
+        "Name":"A new subscription name"
+	}
+}
+

data/spec/mock_helper.rb

@@ -32,15 +32,19 @@ def stub_api_delete(service_path, stub_fixture="success.json", opts={})
   log_stub(s)
 end
 def stub_api_post(service_path, body, stub_fixture="success.json", opts={})
-  body_hash = MultiJson.load(fixture(body).read)
-  body_str = MultiJson.dump(body_hash)
+  if body.is_a?(Hash)
+    body = { :D => body } unless body.empty? 
+  elsif !body.nil?
+    body = MultiJson.load(fixture(body).read)
+  end
+  body_str = body.nil? ? body : MultiJson.dump(body)
   params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
   sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params, body_str)
   s=stub_request(:post, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
       with(:query => {
         :ApiSig => sig        
         }.merge(params),
-        :body => body_str
+        :body => body
       )
   if(block_given?)
     yield s
@@ -50,15 +54,19 @@ def stub_api_post(service_path, body, stub_fixture="success.json", opts={})
   log_stub(s)
 end
 def stub_api_put(service_path, body, stub_fixture="success.json", opts={})
-  body_hash = MultiJson.load(fixture(body).read)
-  body_str = MultiJson.dump(body_hash)
+  if body.is_a? Hash
+    body = { :D => body }
+  elsif !body.nil?
+    body = MultiJson.load(fixture(body).read)
+  end
+  body_str = body.nil? ? body : MultiJson.dump(body)
   params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
   sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params, body_str)
   s=stub_request(:put, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
       with(:query => {
         :ApiSig => sig        
         }.merge(params),
-        :body => body_str
+        :body => body
       )
   if(block_given?)
     yield s

data/spec/oauth2_helper.rb

@@ -7,6 +7,7 @@ class TestOAuth2Provider < SparkApi::Authentication::BaseOAuth2Provider
     @redirect_uri = "https://exampleapp.fbsdata.com/oauth-callback"
     @client_id="example-id"
     @client_secret="example-password"    
+    @sparkbar_uri = "https://test.sparkplatform.com/appbar/authorize"
     @session_cache = {}
   end
   
@@ -56,6 +57,7 @@ class TestCLIOAuth2Provider < SparkApi::Authentication::BaseOAuth2Provider
     nil
   end
   def session_timeout; 60; end
+    
 end
 
 

data/spec/spec_helper.rb

@@ -31,15 +31,12 @@ end
 
 SparkApi.logger.info("Setup gem for rspec testing")
 
+include SparkApi::Models
+
 def reset_config
   SparkApi.reset
-  SparkApi.configure do |config|
-    config.api_user = "foobar"
-  end
+  SparkApi.configure { |c| c.api_user = "foobar" }
 end
-reset_config
-
-include SparkApi::Models
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
@@ -47,5 +44,5 @@ RSpec.configure do |config|
   config.alias_example_to :on_put_it, :method => 'PUT'
   config.alias_example_to :on_post_it, :method => 'POST'
   config.alias_example_to :on_delete_it, :method => 'DELETE'
+  config.before(:all) { reset_config }
 end
-

data/spec/unit/spark_api/authentication/api_auth_spec.rb

@@ -140,7 +140,6 @@ describe SparkApi::Authentication::ApiAuth  do
   
   context "when the server says the session is expired (even if we disagree)" do
     it "should reset the session and reauthenticate" do
-      reset_config
       count = 0
       # Make sure the auth request goes out twice.
       stub_request(:post, "https://api.sparkapi.com/#{SparkApi.version}/session").

data/spec/unit/spark_api/authentication/oauth2_impl/faraday_middleware_spec.rb

@@ -0,0 +1,32 @@
+require './spec/spec_helper'
+require './spec/oauth2_helper'
+
+describe SparkApi::Authentication::OAuth2Impl::SparkbarFaradayMiddleware do
+  subject { SparkApi::Authentication::OAuth2Impl::SparkbarFaradayMiddleware.new("test") }
+  # Make sure the client boostraps the right plugin based on configuration.
+  it "should parse token on successful response" do
+    env = {
+      :body => '{"token":"sp4rkb4rt0k3n"}',
+      :status => 201
+    }
+    subject.on_complete env
+    env[:body]["token"].should eq("sp4rkb4rt0k3n")
+  end
+  
+  it "should raise error on unsuccessful response" do
+    env = {
+      :body => '{"token":"sp4rkb4rt0k3n"}',
+      :status => 500
+    }
+    expect {subject.on_complete env }.to raise_error(SparkApi::ClientError)
+  end
+
+  it "should raise error on invalid json" do
+    env = {
+      :body => '{"BORKBORKBORK"}',
+      :status => 200
+    }
+    expect {subject.on_complete env }.to raise_error(MultiJson::DecodeError)
+  end
+  
+end

data/spec/unit/spark_api/authentication/oauth2_impl/single_session_provider_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe SparkApi::Authentication::SingleSessionProvider do
+  subject { SparkApi::Authentication::SingleSessionProvider.new({ :access_token => "the_token" }) }
+  it "should initialize a new session with access_token" do
+    subject.load_session.should respond_to(:access_token)
+    subject.load_session.access_token.should eq("the_token")
+  end
+end

data/spec/unit/spark_api/authentication/oauth2_spec.rb

@@ -2,8 +2,12 @@ require './spec/spec_helper'
 require './spec/oauth2_helper'
 
 describe SparkApi::Authentication::OAuth2  do
+  before(:all) { SparkApi.reset } # dump api user stuff from other tests
   let(:provider) { TestOAuth2Provider.new() }
-  let(:client) { SparkApi::Client.new({:authentication_mode => SparkApi::Authentication::OAuth2,:oauth2_provider => provider}) }
+  let(:client) { SparkApi::Client.new({
+    :authentication_mode => SparkApi::Authentication::OAuth2,
+    :oauth2_provider => provider,
+    :sparkbar_uri => "https://test.sparkplatform.com/appbar/authorize"}) }
   subject {client.authenticator }  
   # Make sure the client boostraps the right plugin based on configuration.
   describe "plugin" do
@@ -50,7 +54,6 @@ describe SparkApi::Authentication::OAuth2  do
     end
   end
 
-
   describe "logout" do
     let(:session) { mock_oauth_session }
     it "should logout when there is an active session" do
@@ -96,6 +99,24 @@ describe SparkApi::Authentication::OAuth2  do
       subject.request(:post, "/#{SparkApi.version}/contacts", contact, args).status.should eq(201)
     end
   end
+  
+  describe "sparkbar_token" do
+    let(:session) { mock_oauth_session }
+    it "should fetch a sparkbar token" do
+      c = stub_request(:post, "https://test.sparkplatform.com/appbar/authorize").
+        with(:body => "access_token=#{session.access_token}").
+        to_return(:body => '{"token":"sp4rkb4rt0k3n"}')
+      subject.session = session
+      subject.sparkbar_token.should eq("sp4rkb4rt0k3n")
+    end
+    it "should raise an error on missing sparkbar token" do
+      c = stub_request(:post, "https://test.sparkplatform.com/appbar/authorize").
+        with(:body => "access_token=#{session.access_token}").
+        to_return(:body => '{"foo":"bar"}')
+      subject.session = session
+      expect {subject.sparkbar_token }.to raise_error(SparkApi::ClientError)
+    end
+  end
 
   context "with an expired session" do
     context "and a valid refresh token" do
@@ -246,7 +267,7 @@ describe "password authentication" do
 end
 describe SparkApi::Authentication::OAuth2Impl  do
   it "should load a provider" do
-    example = "SparkApi::Authentication::OAuth2Impl::PasswordProvider"
+    example = "SparkApi::Authentication::OAuth2Impl::CLIProvider"
     SparkApi::Authentication::OAuth2Impl.load_provider(example,{}).class.to_s.should eq(example)
     prefix = "::#{example}"
     SparkApi::Authentication::OAuth2Impl.load_provider(prefix,{}).class.to_s.should eq(example)
@@ -282,4 +303,9 @@ describe SparkApi::Authentication::OAuthSession do
     session.start_time.should eq(DateTime.parse(args[:start_time]))
     JSON.parse(session.to_json).should eq(JSON.parse(args.to_json))
   end
+
+  it "should not expire if expires_in is nil" do
+    session = SparkApi::Authentication::OAuthSession.new
+    session.expired?.should eq(false)
+  end
 end

data/spec/unit/spark_api/authentication_spec.rb

@@ -1,19 +1,12 @@
 require './spec/spec_helper'
 
 describe SparkApi::Authentication do
-  before(:all) do
-    SparkApi.reset
-  end
-  
-  after(:all) do
-    reset_config
-  end
-
   it "should give me a session object" do
     stub_auth_request
     stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/session/c401736bf3d3f754f07c04e460e09573").
       with(:query => {
-        :ApiSig => "5596eff4550d74ec6802ac2d637ae5ae",
+        :ApiSig => "d4cea51b4a6b9eb930e4320866aae7d0",
+        :ApiUser => "foobar",
         :AuthToken => "c401736bf3d3f754f07c04e460e09573"
       }).
       to_return(:body => fixture("session.json"))
@@ -26,7 +19,8 @@ describe SparkApi::Authentication do
     stub_auth_request
     stub_request(:delete, "#{SparkApi.endpoint}/#{SparkApi.version}/session/c401736bf3d3f754f07c04e460e09573").
       with(:query => {
-        :ApiSig => "5596eff4550d74ec6802ac2d637ae5ae",
+        :ApiSig => "d4cea51b4a6b9eb930e4320866aae7d0",
+        :ApiUser => "foobar",
         :AuthToken => "c401736bf3d3f754f07c04e460e09573"
       }).
       to_return(:body => fixture("success.json"))

data/spec/unit/spark_api/configuration/yaml_spec.rb

@@ -8,11 +8,12 @@ describe SparkApi::Configuration::YamlConfig, "Yaml Config"  do
       subject.api_env.should eq("development")
       subject.load_file(api_file)
       subject.oauth2?.should eq(false)
+      subject.ssl_verify?.should eq(false)
       subject.api_key.should eq("demo_key")
       subject.api_secret.should eq("t3sts3cr3t")
       subject.endpoint.should eq("https://developers.sparkapi.com")
       subject.name.should eq("test_key")
-      subject.client_keys.keys.should =~ [:api_key, :api_secret, :endpoint]
+      subject.client_keys.keys.should =~ [:api_key, :api_secret, :endpoint, :ssl_verify]
       subject.oauth2_keys.keys.should eq([])
     end
     it "should load a configured api key for production" do
@@ -47,7 +48,7 @@ describe SparkApi::Configuration::YamlConfig, "Yaml Config"  do
       subject.oauth2_provider.should eq("SparkApi::TestOAuth2Provider")
       subject.name.should eq("test_oauth")
       subject.client_keys.keys.should =~ [:endpoint, :oauth2_provider]
-      subject.oauth2_keys.keys.should =~ [:authorization_uri, :client_id, :access_uri, :client_secret, :redirect_uri]
+      subject.oauth2_keys.keys.should =~ [:authorization_uri, :client_id, :access_uri, :client_secret, :redirect_uri, :sparkbar_uri]
     end
     it "should load a configured api key for production" do
       subject.stub(:env){ {"SPARK_API_ENV" => "production"} }
@@ -66,7 +67,7 @@ describe SparkApi::Configuration::YamlConfig, "Yaml Config"  do
     
     it "should list available keys" do
       SparkApi::Configuration::YamlConfig.stub(:config_path) { "spec/config/spark_api" }
-      subject.class.config_keys.should =~ ["test_key", "test_oauth"]
+      subject.class.config_keys.should =~ ["test_key", "test_oauth", "test_single_session_oauth"]
     end
   end
 end