spark_api 1.0.0

data/spec/unit/spark_api/authentication_spec.rb

@@ -0,0 +1,38 @@
+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",
+        :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+      }).
+      to_return(:body => fixture("session.json"))
+    client = SparkApi.client
+    stub_auth_request
+    session = client.get "/session/c401736bf3d3f754f07c04e460e09573"
+    session[0]["AuthToken"].should eq("c401736bf3d3f754f07c04e460e09573")
+  end
+  it "should delete a session" do
+    stub_auth_request
+    stub_request(:delete, "#{SparkApi.endpoint}/#{SparkApi.version}/session/c401736bf3d3f754f07c04e460e09573").
+      with(:query => {
+        :ApiSig => "5596eff4550d74ec6802ac2d637ae5ae",
+        :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+      }).
+      to_return(:body => fixture("success.json"))
+    client = SparkApi.client
+    client.logout
+    client.session.should eq(nil)
+  end
+
+end

data/spec/unit/spark_api/authentication_spec.rb~

@@ -0,0 +1,38 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi::Authentication do
+  before(:all) do
+    FlexmlsApi.reset
+  end
+  
+  after(:all) do
+    reset_config
+  end
+
+  it "should give me a session object" do
+    stub_auth_request
+    stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/session/c401736bf3d3f754f07c04e460e09573").
+      with(:query => {
+        :ApiSig => "5596eff4550d74ec6802ac2d637ae5ae",
+        :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+      }).
+      to_return(:body => fixture("session.json"))
+    client = FlexmlsApi.client
+    stub_auth_request
+    session = client.get "/session/c401736bf3d3f754f07c04e460e09573"
+    session[0]["AuthToken"].should eq("c401736bf3d3f754f07c04e460e09573")
+  end
+  it "should delete a session" do
+    stub_auth_request
+    stub_request(:delete, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/session/c401736bf3d3f754f07c04e460e09573").
+      with(:query => {
+        :ApiSig => "5596eff4550d74ec6802ac2d637ae5ae",
+        :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+      }).
+      to_return(:body => fixture("success.json"))
+    client = FlexmlsApi.client
+    client.logout
+    client.session.should eq(nil)
+  end
+
+end

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

@@ -0,0 +1,72 @@
+require './spec/spec_helper'
+
+describe SparkApi::Configuration::YamlConfig, "Yaml Config"  do
+  describe "api auth" do
+    let(:api_file){ "spec/config/spark_api/test_key.yml" }
+    it "should load a configured api key for development" do
+      subject.stub(:env){ {} }
+      subject.api_env.should eq("development")
+      subject.load_file(api_file)
+      subject.oauth2?.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.oauth2_keys.keys.should eq([])
+    end
+    it "should load a configured api key for production" do
+      subject.stub(:env){ {"SPARK_API_ENV" => "production"} }
+      subject.api_env.should eq("production")
+      subject.load_file(api_file)
+      subject.oauth2?.should eq(false)
+      subject.api_key.should eq("prod_demo_key")
+      subject.api_secret.should eq("prod_t3sts3cr3t")
+      subject.endpoint.should eq("https://api.sparkapi.com")
+    end
+    it "should raise an error for a bad configuration" do
+      subject.stub(:env){ {} }
+      expect { subject.load_file("spec/config/spark_api/some_random_key.yml")}.to raise_error
+      subject.stub(:env){ {"RAILS_ENV" => "fake_env"} }
+      expect { subject.load_file(api_file)}.to raise_error
+    end
+  end
+  describe "oauth2" do
+    let(:oauth2_file){ "spec/config/spark_api/test_oauth.yml" }
+    it "should load a configured api key for development" do
+      subject.stub(:env){ {} }
+      subject.api_env.should eq("development")
+      subject.load_file(oauth2_file)
+      subject.oauth2?.should eq(true)
+      subject.authorization_uri.should eq("https://developers.sparkplatform.com/oauth2")
+      subject.access_uri.should eq("https://developers.sparkapi.com/v1/oauth2/grant")
+      subject.redirect_uri.should eq("http://localhost/oauth2/callback")
+      subject.client_id.should eq("developmentid124nj4qu3pua")
+      subject.client_secret.should eq("developmentsecret4orkp29f")
+      subject.endpoint.should eq("https://developers.sparkapi.com")
+      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]
+    end
+    it "should load a configured api key for production" do
+      subject.stub(:env){ {"SPARK_API_ENV" => "production"} }
+      subject.api_env.should eq("production")
+      subject.load_file(oauth2_file)
+      subject.oauth2?.should eq(true)
+      subject.authorization_uri.should eq("https://sparkplatform.com/oauth2")
+      subject.access_uri.should eq("https://api.sparkapi.com/v1/oauth2/grant")
+      subject.redirect_uri.should eq("http://localhost/oauth2/callback")
+      subject.client_id.should eq("production1id124nj4qu3pua")
+      subject.client_secret.should eq("productionsecret4orkp29fv")
+      subject.endpoint.should eq("https://api.sparkapi.com")
+      subject.oauth2_provider.should eq(subject.class::DEFAULT_OAUTH2_PROVIDER)
+      subject.name.should eq("test_oauth")
+    end
+    
+    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"]
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi::Configuration::YamlConfig, "Yaml Config"  do
+  describe "api auth" do
+    let(:api_file){ "spec/config/flexmls_api/test_key.yml" }
+    it "should load a configured api key for development" do
+      subject.stub(:env){ {} }
+      subject.api_env.should eq("development")
+      subject.load_file(api_file)
+      subject.oauth2?.should eq(false)
+      subject.api_key.should eq("demo_key")
+      subject.api_secret.should eq("t3sts3cr3t")
+      subject.endpoint.should eq("http://api.dev.flexmls.com")
+      subject.name.should eq("test_key")
+      subject.client_keys.keys.should =~ [:api_key, :api_secret, :endpoint]
+      subject.oauth2_keys.keys.should eq([])
+    end
+    it "should load a configured api key for production" do
+      subject.stub(:env){ {"FLEXMLS_API_ENV" => "production"} }
+      subject.api_env.should eq("production")
+      subject.load_file(api_file)
+      subject.oauth2?.should eq(false)
+      subject.api_key.should eq("prod_demo_key")
+      subject.api_secret.should eq("prod_t3sts3cr3t")
+      subject.endpoint.should eq("http://api.test.flexmls.com")
+    end
+    it "should raise an error for a bad configuration" do
+      subject.stub(:env){ {} }
+      expect { subject.load_file("spec/config/flexmls_api/some_random_key.yml")}.to raise_error
+      subject.stub(:env){ {"RAILS_ENV" => "fake_env"} }
+      expect { subject.load_file(api_file)}.to raise_error
+    end
+  end
+  describe "oauth2" do
+    let(:oauth2_file){ "spec/config/flexmls_api/test_oauth.yml" }
+    it "should load a configured api key for development" do
+      subject.stub(:env){ {} }
+      subject.api_env.should eq("development")
+      subject.load_file(oauth2_file)
+      subject.oauth2?.should eq(true)
+      subject.authorization_uri.should eq("https://dev.flexmls.com/r/login/")
+      subject.access_uri.should eq("https://api.dev.flexmls.com/v1/oauth2/grant")
+      subject.redirect_uri.should eq("http://localhost/oauth2/callback")
+      subject.client_id.should eq("developmentid124nj4qu3pua")
+      subject.client_secret.should eq("developmentsecret4orkp29f")
+      subject.endpoint.should eq("http://api.dev.flexmls.com")
+      subject.oauth2_provider.should eq("FlexmlsApi::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]
+    end
+    it "should load a configured api key for production" do
+      subject.stub(:env){ {"FLEXMLS_API_ENV" => "production"} }
+      subject.api_env.should eq("production")
+      subject.load_file(oauth2_file)
+      subject.oauth2?.should eq(true)
+      subject.authorization_uri.should eq("https://www.flexmls.com/r/login/")
+      subject.access_uri.should eq("https://api.flexmls.com/v1/oauth2/grant")
+      subject.redirect_uri.should eq("http://localhost/oauth2/callback")
+      subject.client_id.should eq("production1id124nj4qu3pua")
+      subject.client_secret.should eq("productionsecret4orkp29fv")
+      subject.endpoint.should eq("http://api.flexmls.com")
+      subject.oauth2_provider.should eq(subject.class::DEFAULT_OAUTH2_PROVIDER)
+      subject.name.should eq("test_oauth")
+    end
+    
+    it "should list available keys" do
+      FlexmlsApi::Configuration::YamlConfig.stub(:config_path) { "spec/config/flexmls_api" }
+      subject.class.config_keys.should =~ ["test_key", "test_oauth"]
+    end
+  end
+end

data/spec/unit/spark_api/configuration_spec.rb

@@ -0,0 +1,122 @@
+require './spec/spec_helper'
+
+describe SparkApi::Client, "Client config"  do
+  after(:all) do
+    reset_config
+  end
+
+  describe "default settings" do
+    it "should return the proper defaults when called with no arguments" do
+      SparkApi.api_key.should be_nil
+      SparkApi.api_secret.should be_nil
+      SparkApi.version.should match("v1")
+      SparkApi.endpoint.should match("api.sparkapi.com")
+      SparkApi.user_agent.should match(/Spark API Ruby Gem .*/)
+      SparkApi.api_key = "my_api_key"
+      SparkApi.api_key.should match("my_api_key")
+    end
+  end
+
+  describe "instance config" do
+    it "should return a properly configured client" do
+      client = SparkApi::Client.new(:api_key => "key_of_wade", 
+                                      :api_secret => "TopSecret", 
+                                      :api_user => "1234",
+                                      :endpoint => "http://api.wade.dev.fbsdata.com")
+ 
+      client.api_key.should match("key_of_wade")
+      client.api_secret.should match("TopSecret")
+      client.api_user.should match("1234")
+      client.endpoint.should match("http://api.wade.dev.fbsdata.com")
+      client.version.should match("v1")
+    end
+  end
+
+  describe "block config" do
+    it "should correctly set up the client" do
+      SparkApi.configure do |config|
+        config.api_key = "my_key"
+        config.api_secret = "my_secret"
+        config.api_user = "1234"
+        config.version = "veleventy"
+        config.endpoint = "test.api.sparkapi.com"
+        config.user_agent = "my useragent"
+      end
+
+      SparkApi.api_key.should match("my_key")
+      SparkApi.api_secret.should match("my_secret")
+      SparkApi.api_user.should match("1234")
+      SparkApi.version.should match("veleventy")
+      SparkApi.endpoint.should match("test.api.sparkapi.com")
+      SparkApi.user_agent.should match("my useragent")
+
+    end
+    
+    it "should reset" do
+      SparkApi.configure do |config|
+        config.api_key = "my_key"
+        config.api_secret = "my_secret"
+        config.version = "veleventy"
+        config.endpoint = "test.api.sparkapi.com"
+        config.user_agent = "my useragent"
+      end
+      
+      SparkApi.api_key.should match("my_key")
+      SparkApi.reset
+      SparkApi.api_key.should == SparkApi::Configuration::DEFAULT_API_KEY
+    
+    end
+  end
+
+  describe "connections" do
+    it "should use http by default" do
+      stub_auth_request
+      stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/connections").
+          with(:query => {
+            :ApiSig => "951e5ba0496b0758356d3cc7676f8b21",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":false}]}}')
+          
+      SparkApi.client.get('/connections')[0]["SSL"].should eq(false)
+    end
+
+    it "should use https when ssl is enabled" do
+      stub_auth_request
+      stub_request(:get, "https://api.sparkapi.com/#{SparkApi.version}/connections").
+          with(:query => {
+            :ApiSig => "951e5ba0496b0758356d3cc7676f8b21",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":true}]}}')
+          
+      c = SparkApi::Client.new(:endpoint => "https://api.sparkapi.com", :ssl => true)
+      c.get('/connections')[0]["SSL"].should eq(true)
+    end
+    
+    it "should have correct headers based on configuration" do
+      stub_auth_request
+      stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/headers").
+          with(:query => {
+            :ApiSig => "6f0cfef263e0bfe7a9ae1f60063a8ad9",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": []}}')
+      SparkApi.reset
+      SparkApi.configure do |config|
+        config.user_agent = "my useragent"
+      end
+      SparkApi.client.get '/headers'
+      WebMock.should have_requested(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/headers?ApiSig=6f0cfef263e0bfe7a9ae1f60063a8ad9&AuthToken=c401736bf3d3f754f07c04e460e09573").
+        with(:headers => {
+          'User-Agent' => SparkApi::Configuration::DEFAULT_USER_AGENT,
+          SparkApi::Configuration::X_SPARK_API_USER_AGENT => "my useragent",
+          'Accept'=>'application/json', 
+          'Content-Type'=>'application/json'
+        })
+    end
+    
+  end
+
+end
+

data/spec/unit/spark_api/configuration_spec.rb~

@@ -0,0 +1,122 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi::Client, "Client config"  do
+  after(:all) do
+    reset_config
+  end
+
+  describe "default settings" do
+    it "should return the proper defaults when called with no arguments" do
+      FlexmlsApi.api_key.should be_nil
+      FlexmlsApi.api_secret.should be_nil
+      FlexmlsApi.version.should match("v1")
+      FlexmlsApi.endpoint.should match("api.flexmls.com")
+      FlexmlsApi.user_agent.should match(/flexmls API Ruby Gem .*/)
+      FlexmlsApi.api_key = "my_api_key"
+      FlexmlsApi.api_key.should match("my_api_key")
+    end
+  end
+
+  describe "instance config" do
+    it "should return a properly configured client" do
+      client = FlexmlsApi::Client.new(:api_key => "key_of_wade", 
+                                      :api_secret => "TopSecret", 
+                                      :api_user => "1234",
+                                      :endpoint => "http://api.wade.dev.fbsdata.com")
+ 
+      client.api_key.should match("key_of_wade")
+      client.api_secret.should match("TopSecret")
+      client.api_user.should match("1234")
+      client.endpoint.should match("http://api.wade.dev.fbsdata.com")
+      client.version.should match("v1")
+    end
+  end
+
+  describe "block config" do
+    it "should correctly set up the client" do
+      FlexmlsApi.configure do |config|
+        config.api_key = "my_key"
+        config.api_secret = "my_secret"
+        config.api_user = "1234"
+        config.version = "veleventy"
+        config.endpoint = "test.api.flexmls.com"
+        config.user_agent = "my useragent"
+      end
+
+      FlexmlsApi.api_key.should match("my_key")
+      FlexmlsApi.api_secret.should match("my_secret")
+      FlexmlsApi.api_user.should match("1234")
+      FlexmlsApi.version.should match("veleventy")
+      FlexmlsApi.endpoint.should match("test.api.flexmls.com")
+      FlexmlsApi.user_agent.should match("my useragent")
+
+    end
+    
+    it "should reset" do
+      FlexmlsApi.configure do |config|
+        config.api_key = "my_key"
+        config.api_secret = "my_secret"
+        config.version = "veleventy"
+        config.endpoint = "test.api.flexmls.com"
+        config.user_agent = "my useragent"
+      end
+      
+      FlexmlsApi.api_key.should match("my_key")
+      FlexmlsApi.reset
+      FlexmlsApi.api_key.should == FlexmlsApi::Configuration::DEFAULT_API_KEY
+    
+    end
+  end
+
+  describe "connections" do
+    it "should use http by default" do
+      stub_auth_request
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/connections").
+          with(:query => {
+            :ApiSig => "951e5ba0496b0758356d3cc7676f8b21",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":false}]}}')
+          
+      FlexmlsApi.client.get('/connections')[0]["SSL"].should eq(false)
+    end
+
+    it "should use https when ssl is enabled" do
+      stub_auth_request
+      stub_request(:get, "https://api.flexmls.com/#{FlexmlsApi.version}/connections").
+          with(:query => {
+            :ApiSig => "951e5ba0496b0758356d3cc7676f8b21",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":true}]}}')
+          
+      c = FlexmlsApi::Client.new(:endpoint => "https://api.flexmls.com", :ssl => true)
+      c.get('/connections')[0]["SSL"].should eq(true)
+    end
+    
+    it "should have correct headers based on configuration" do
+      stub_auth_request
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/headers").
+          with(:query => {
+            :ApiSig => "6f0cfef263e0bfe7a9ae1f60063a8ad9",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": []}}')
+      FlexmlsApi.reset
+      FlexmlsApi.configure do |config|
+        config.user_agent = "my useragent"
+      end
+      FlexmlsApi.client.get '/headers'
+      WebMock.should have_requested(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/headers?ApiSig=6f0cfef263e0bfe7a9ae1f60063a8ad9&AuthToken=c401736bf3d3f754f07c04e460e09573").
+        with(:headers => {
+          'User-Agent' => FlexmlsApi::Configuration::DEFAULT_USER_AGENT,
+          FlexmlsApi::Configuration::X_FLEXMLS_API_USER_AGENT => "my useragent",
+          'Accept'=>'application/json', 
+          'Content-Type'=>'application/json'
+        })
+    end
+    
+  end
+
+end
+