Merge pull request #135 from ryanhertz/newsfeed-meta-requests

Newsfeed meta requests

Author: ryanhertz

CHANGELOG

@@ -1,3 +1,6 @@
+v1.4.14
+ - fixed duplicate requests in NewsFeedMeta
+
 v1.4.13
  - added SystemInfoSearch model
 

VERSION

@@ -1 +1 @@
-1.4.13
+1.4.14

lib/spark_api/models/news_feed_meta.rb

@@ -31,7 +31,11 @@ def core_fields
       private
 
       def data
-        @data ||= connection.get(self.path).first
+        if attributes.empty?
+          @data ||= connection.get(self.path).first
+        else
+          attributes
+        end
       end
 
     end

spec/spec_helper.rb

@@ -48,6 +48,10 @@ def reset_config
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 
 RSpec.configure do |config|
+  
+  config.include WebMock::API
+  config.include StubApiRequests
+
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.alias_example_to :on_get_it, :method => 'GET'
   config.alias_example_to :on_put_it, :method => 'PUT'

spec/support/mock_helper.rb

@@ -1,87 +1,3 @@
-RSpec.configure do |config|
-  config.include WebMock::API
-end
-
-$test_client = SparkApi::Client.new({:api_key=>"", :api_secret=>""})
-
-def stub_api_get(service_path, stub_fixture="success.json", opts={})
-  params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
-  sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params)
-  s=stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
-      with(:query => {
-        :ApiSig => sig        
-        }.merge(params))
-  if(block_given?)
-    yield s
-  else
-    s.to_return(:body => fixture(stub_fixture))
-  end
-  log_stub(s)
-end
-def stub_api_delete(service_path, stub_fixture="success.json", opts={})
-  params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
-  sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params)
-  s=stub_request(:delete, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
-      with(:query => {
-        :ApiSig => sig
-        }.merge(params))
-  if(block_given?)
-    yield s
-  else
-    s.to_return(:body => fixture(stub_fixture))
-  end
-  log_stub(s)
-end
-def stub_api_post(service_path, body, stub_fixture="success.json", opts={})
-  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
-      )
-  if(block_given?)
-    yield s
-  else
-    s.to_return(:body => fixture(stub_fixture))
-  end
-  log_stub(s)
-end
-def stub_api_put(service_path, body, stub_fixture="success.json", opts={})
-  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)
-  full_path = "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}"
-  s=stub_request(:put, full_path).with(:query => {
-        :ApiSig => sig
-        }.merge(params),
-        :body => body
-      )
-  if(block_given?)
-    yield s
-  else
-    s.to_return(:body => fixture(stub_fixture))
-  end
-  log_stub(s)
-end
-
-def log_stub(s)
-  SparkApi.logger.debug("Stubbed Request: #{s.inspect} \n\n")
-  return s
-end
-
 def mock_session()
   SparkApi::Authentication::Session.new("AuthToken" => "1234", "Expires" => (Time.now + 3600).to_s, "Roles" => "['idx']")
 end

spec/support/stub_api_requests.rb

@@ -0,0 +1,72 @@
+module StubApiRequests
+
+  def stub_api_get(service_path, stub_fixture="success.json", opts={}, &block)
+    stub_api_request(:get, service_path, stub_fixture, nil, opts, &block)
+  end
+
+  def stub_api_delete(service_path, stub_fixture="success.json", opts={}, &block)
+    stub_api_request(:delete, service_path, stub_fixture, nil, opts, &block)
+  end
+
+  def stub_api_post(service_path, body, stub_fixture="success.json", opts={}, &block)
+    stub_api_request(:post, service_path, stub_fixture, body, opts, &block)
+  end
+
+  def stub_api_put(service_path, body, stub_fixture="success.json", opts={}, &block)  
+    stub_api_request(:put, service_path, stub_fixture, body, opts, &block)
+  end
+
+  def expect_api_request(meth, service_path, body=nil, opts={})
+    args = with_args(service_path, opts, body)
+    expect(a_request(meth, full_path(service_path)).with(args))
+  end
+  
+  private
+
+  def full_path(path)
+    "#{SparkApi.endpoint}/#{SparkApi.version}#{path}"
+  end
+
+  def stub_api_request(meth, service_path, stub_fixture, body, opts, &block)
+    args = with_args(service_path, opts, body)
+    s = stub_request(meth, full_path(service_path)).with(args)
+
+    if(block_given?)
+      yield s
+    else
+      s.to_return(:body => fixture(stub_fixture))
+    end
+    log_stub(s)
+  end
+
+  def with_args(service_path, opts, body=nil)
+    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)
+    query = {:ApiSig => get_signature(service_path, params, body_str) }
+    query.merge!(params)
+
+    ret = {query: query}
+    ret[:body] = body unless body.nil?
+    ret
+  end
+
+  def test_client
+    @test_client ||= SparkApi::Client.new({:api_key=>"", :api_secret=>""})
+  end
+
+  def get_signature(service_path, params, body_str=nil)
+    test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params, body_str)
+  end
+
+  def log_stub(s)
+    SparkApi.logger.debug("Stubbed Request: #{s.inspect} \n\n")
+    return s
+  end
+
+end

spec/unit/spark_api/models/news_feed_meta_spec.rb

@@ -10,6 +10,14 @@
     stub_api_get("/newsfeeds/meta", "newsfeeds/meta.json")
   end
 
+  describe 'fetching data' do
+    it "only makes one api request" do
+      news_feed_meta = NewsFeedMeta.get.first
+      news_feed_meta.minimum_core_fields
+      expect_api_request(:get, "/newsfeeds/meta").to have_been_made.once
+    end
+  end
+
   describe 'minimum_core_fields' do
     it 'returns the minimum number of required fields' do
       expect(news_feed_meta.minimum_core_fields).to eq 3