tpdata 1.0.12 → 1.1.0

data/.gitignore

@@ -0,0 +1,31 @@
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+.bundle
+pkg/*
+tags
+Gemfile.lock
+test/tmp/
+
+# Versioning
+.rbenv-version
+.rvmrc
+
+# Documentation
+_site/*
+.yardoc/
+doc/
+
+# Python
+*.pyc
+
+# Rubinius
+*.rbc
+
+# IDE junk
+.idea/*
+*.iml
+
+# Testing
+coverage

data/Gemfile

@@ -1,9 +1,2 @@
 source :rubygems
-
-gem 'httparty'
-
-# Testing
-group :test do
-	gem 'rspec'
-	gem 'rake'
-end
+gemspec

data/Manifest.txt

@@ -1,3 +1,4 @@
+.gitignore
 Gemfile
 Manifest.txt
 README.md
@@ -13,3 +14,4 @@ spec/lib/data_spec.rb
 spec/lib/identity_spec.rb
 spec/spec_helper.rb
 theplatform.gemspec
+tpdata_version

data/Rakefile

@@ -3,8 +3,11 @@
 require 'rspec/core/rake_task'
 
 desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = './spec/*/*_spec.rb'
-end
+RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+task :coverage do |t|
+  ENV["COVERAGE"] = 'true'
+  Rake::Task[:spec].execute
+end

data/lib/theplatform.rb

@@ -1,12 +1,10 @@
-$:.unshift( File.dirname( __FILE__ ))
-
 require 'httparty'
 
 # Start of wrapper for tpdata
 module ThePlatform
 
-  # Set gem version
-  VERSION = '1.0.12'
+  # Set Version
+  VERSION = File.read(File.expand_path("../../tpdata_version",__FILE__)).strip
 
   require 'theplatform/configuration'
   require 'theplatform/services'

data/lib/theplatform/configuration.rb

@@ -24,20 +24,20 @@ module ThePlatform
     # List available parameters and values in those params
     def parameters
       @values = {}
-      keys.each { |k| @values.merge! k => get_var("@#{k}") }
+      keys.each { |k| @values.merge! k => get_var(k) unless get_var(k) == nil }
       @values
     end
 
     # Returns true or false if all parameters are set.
     def parameters?
-      parameters.values.all?
+      parameters.keys == keys
     end
 
     private
 
     # Helper to clean up recursive method in #parameters
     def get_var(var)
-      self.instance_variable_get(var)
+      self.instance_variable_get("@#{var}")
     end
 
   end

data/spec/lib/configuration_spec.rb

@@ -25,7 +25,7 @@ describe ThePlatform::Configuration do
     it 'should return false if all values are not set' do
       ThePlatform::Data.schema = nil
       ThePlatform::Data.parameters[:schema].should == nil
-      ThePlatform::Data.parameters?.should be false
+      ThePlatform::Data.parameters?.should eq false
     end
 
   end

data/spec/lib/data_spec.rb

@@ -28,39 +28,133 @@ describe ThePlatform::Data do
 
   describe 'requests' do
 
-    it 'should return 200' do
-      ThePlatform.const_get(:SERVICE).keys.each do |endpoint|
-        ThePlatform::Data.send(endpoint).get('', 'all', schema:'1.0', form:'json').code.should == 200
+    it 'should return a HTTParty::Response object' do
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        stub_request(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/")
+                    .with(:query => hash_including({}))
+                    .to_return(:status => 200, :body => "", :headers => {})
+        ThePlatform::Data.send(service).get('','all',{}).class == HTTParty::Response
       end
     end
 
     it 'should make a GET against an endpoint' do
-      ThePlatform.const_get(:SERVICE).keys.each do |endpoint|
-        ThePlatform::Data.send(endpoint).get('Object', 'all').request.instance_variable_get(:@http_method).should equal Net::HTTP::Get
+      object = "Object"
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        stub_request(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/" + object)
+                    .with(:query => hash_including({}))
+
+        ThePlatform::Data.send(service).get(object, 'all')
+
+        WebMock.should have_requested(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'data/' + object)
+               .with(:query => hash_including({}))
       end
     end
 
     it 'should make a POST against an endpoint' do
-      ThePlatform.const_get(:SERVICE).keys.each do |endpoint|
-        ThePlatform::Data.send(endpoint).post('Object', '{BODY}').request.instance_variable_get(:@http_method).should equal Net::HTTP::Post
+      object = "Object"
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        stub_request(:post, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/" + object)
+                    .with(:query => hash_including({}))
+
+        ThePlatform::Data.send(service).post(object, 'all')
+
+        WebMock.should have_requested(:post, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'data/' + object)
+               .with(:query => hash_including({}))
       end
     end
 
     it 'should make a PUT against an endpoint' do
-      ThePlatform.const_get(:SERVICE).keys.each do |endpoint|
-        ThePlatform::Data.send(endpoint).put('Object', '{BODY}').request.instance_variable_get(:@http_method).should equal Net::HTTP::Put
+      object = "Object"
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        stub_request(:put, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/" + object)
+                    .with(:query => hash_including({}))
+
+        ThePlatform::Data.send(service).put(object, 'all')
+
+        WebMock.should have_requested(:put, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'data/' + object)
+               .with(:query => hash_including({}))
       end
     end
 
     it 'should make a DELETE against an endpoint' do
-      ThePlatform.const_get(:SERVICE).keys.each do |endpoint|
-        ThePlatform::Data.send(endpoint).delete('Object', 'IDS').request.instance_variable_get(:@http_method).should equal Net::HTTP::Delete
+      object = "Object"
+      objectId = '123'
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        stub_request(:delete, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/" + object + "/" + objectId)
+                    .with(:query => hash_including({}))
+
+        ThePlatform::Data.send(service).delete(object, objectId)
+
+        WebMock.should have_requested(:delete, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'data/' + object + "/" + objectId)
+               .with(:query => hash_including({}))
       end
     end
 
-    it 'should be able to use the NOTIFY method' do
-      ThePlatform.const_get(:SERVICE).keys.each do |endpoint|
-        ThePlatform::Data.send(endpoint).notify('options').request.instance_variable_get(:@http_method).should equal Net::HTTP::Get
+    it 'should perform GET method on the NOTIFY endpoint' do
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        stub_request(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "notify")
+                    .with(:query => hash_including({}))
+
+        ThePlatform::Data.send(service).notify(token:'Nez8Y9ScVDxPxLDmUsg_ESCDYJCJwPBk', size:'10', since:'11111111')
+
+        WebMock.should have_requested(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'notify')
+               .with(:query => hash_including({}))
+      end
+    end
+
+    it 'should bubble up any exception' do
+      object = "Object"
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        stub_request(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/" + object)
+                    .with(:query => hash_including({}))
+                    .to_raise(Exception)
+
+        expect{ThePlatform::Data.send(service).get(object, 'all')}.to raise_error(Exception)
+
+        WebMock.should have_requested(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'data/' + object)
+               .with(:query => hash_including({}))
+      end
+    end
+
+    it 'should show the gem name/version number as the User-Agent' do
+      object = "Object"
+      version = File.read(File.expand_path("../../../tpdata_version",__FILE__)).strip
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        stub_request(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/" + object)
+                    .with(:query => hash_including({}))
+
+        ThePlatform::Data.send(service).get(object, 'all')
+
+        WebMock.should have_requested(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'data/' + object)
+               .with(:query => hash_including({}), :headers => {"User-Agent" => "tpdata/#{version}"})
+      end
+    end
+
+    it 'should make the correct Content-Type request' do
+      object = "Object"
+      ThePlatform.const_get(:SERVICE).keys.each do |service|
+        WebMock.reset!
+        content_type = {'atom' => 'application/atom+xml',
+                        'rss'  => 'application/rss+xml',
+                        'json' => 'application/json',
+                        'cjson' => 'application/json'}
+
+        content_type.each do |format|
+          stub_request(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + "data/" + object)
+                      .with(:query => hash_including({}))
+
+          ThePlatform::Data.send(service).get(object, 'all',form:format[0])
+
+          WebMock.should have_requested(:get, ThePlatform.const_get(:SERVICE)[service][:endpoint] + 'data/' + object)
+                 .with(:query => hash_including({form:format[0]}), :headers => {"Content-Type" => format[1]})
+        end
       end
     end
 

data/spec/lib/identity_spec.rb

@@ -2,6 +2,11 @@ require 'spec_helper'
 
 describe ThePlatform::Identity do
 
+  # clear webmock stubs before each test
+  before(:each) do
+    WebMock.reset!
+  end
+
   describe 'default attributes' do
 
     it 'should include HTTParty methods' do
@@ -12,50 +17,122 @@ describe ThePlatform::Identity do
 
   describe "#token" do
 
-    it "should return a 200 response" do
-      ThePlatform::Identity.token(form:'json', schema:'1.0').code.should == 200
+      # stub "valid credentials" identity call
+      before(:each) do
+        # reset anything from previous tests
+        WebMock.reset!
+
+        #setup a normal response
+        @duration = ""
+        @idleTimeout = ""
+        @userName = "user"
+        @password = "secret"
+        @form = "json"
+        @schema = "1.0"
+
+        @signInURL = ThePlatform::IDENTITY + 'signIn'
+
+        @query = { "form" => @form,
+                  "password" => @password,
+                  "schema" => @schema,
+                  "username" => @userName,
+                  "_duration" => @duration }
+
+        stub_request(:get, @signInURL).with(:query => @query).to_return(:status => 200, :body => {}, :headers => {})
+      end
+
+    it "should call signIn endpoint with parameters" do
+      ThePlatform::Identity.token(username: @userName, password: @password, form: @form, schema: @schema, _duration: @duration)
+      WebMock.should have_requested(:get, @signInURL)
+             .with(:query => hash_including({"username" => @userName,
+                                             "password" => @password,
+                                             "form" => @form,
+                                             "schema" => @schema,
+                                             "_duration" => @duration}))
     end
 
-    it 'should return BAD REQUEST if no schema or form present' do
-      ThePlatform::Identity.token(test:1, test:2).code.should == 422
+    it "should return a HTTParty::Response from the web request" do
+      ThePlatform::Identity.token(username: @userName, password: @password, form: @form, schema: @schema, _duration: @duration).class.should == HTTParty::Response
     end
 
-    it 'should have a valid return body' do
-      ThePlatform::Identity.token(form:'json', schema:'1.0')['description'].should == "No authentication header."
-    end
+    it "should bubble up any exception" do
+      stub_request(:any, @signInURL)
+                  .with(:query => hash_including({}))
+                  .to_raise(Exception)
 
-    it 'should not authenticate an invalid user' do
-      ThePlatform::Identity.token(form:'json', schema:'1.0', username:'test', password:'pass')['description'].should == "Could not authenticate user test."
+      expect {ThePlatform::Identity.token(username: @userName, password: @password, from: @form, schema: @schema)}.to raise_error(Exception)
     end
+
   end
 
   describe "#invalidate!" do
+    before(:all) do
+      @signOutURL = ThePlatform::IDENTITY + 'signOut'
+    end
+
+    before(:each) do
+      WebMock.reset!
+
+      stub_request(:any, @signOutURL)
+                  .with(:query => hash_including({}))
+                  .to_return(:status => 200, :body => {}, :headers => {})
+    end
+
+    it "should call signOut endpoint with parameters" do
+      @token = 'foo'
+
+      ThePlatform::Identity.invalidate!(@token)
 
-    it 'should return a 200 response' do
-      ThePlatform::Identity.invalidate!('omg_i_haz_a_tokenz', form:'json', schema:'1.0').code.should == 200
+      WebMock.should have_requested(:get, @signOutURL)
+             .with(:query => hash_including({"_token" => @token}))
     end
 
-    it 'should have a valid return body' do
-      ThePlatform::Identity.invalidate!('omg_i_haz_a_tokenz', form:'json', schema:'1.0').should have_key 'signOutResponse'
+    it "should return a HTTParty::Response from the web request" do
+      ThePlatform::Identity.invalidate!(@token).class.should == HTTParty::Response
+    end
+
+    it "should bubble up any exception" do
+      stub_request(:any, @signOutURL)
+                  .with(:query => hash_including({}))
+                  .to_raise(Exception)
+
+      expect {ThePlatform::Identity.invalidate!(@token)}.to raise_error(Exception)
     end
 
   end
 
   describe "#count" do
+    before(:all) do
+      @getTokenCountURL = ThePlatform::IDENTITY + 'getTokenCount'
+    end
+
+    before(:each) do
+      WebMock.reset!
 
-    it "should return a 200 response" do
-      ThePlatform::Identity.count(form:'json', schema:'1.0').code.should == 200
+      stub_request(:any, @getTokenCountURL)
+                  .with(:query => hash_including({}))
+                  .to_return(:status => 200, :body => {}, :headers => {})
     end
 
-    it 'should return a BAD REQUEST if no schema or form are present' do
-      ThePlatform::Identity.count(test:1, test:2).code.should == 422
+    it "should call getTokenCount endpoint with parameters" do
+      ThePlatform::Identity.count(foo: 'bar')
+
+      WebMock.should have_requested(:get, @getTokenCountURL)
+             .with(:query => hash_including({"foo" => 'bar'}))
     end
 
-    it 'should fail if auth is invalid' do
-      ThePlatform::Identity.count(form:'json', schema:'1.0', username:'test', password:'pass')['description'].should == "Could not authenticate user test."
+    it "should return a HTTParty::Response from the web request" do
+      ThePlatform::Identity.count({}).class.should == HTTParty::Response
+    end
+
+    it "should bubble up any exception" do
+      stub_request(:any, @getTokenCountURL)
+                  .with(:query => hash_including({}))
+                  .to_raise(Exception)
+
+      expect {ThePlatform::Identity.count(foo:'bar')}.to raise_error(Exception)
     end
 
   end
 
 end
-

data/spec/spec_helper.rb

@@ -1,4 +1,26 @@
 require 'rubygems'
 require 'rspec'
+require 'webmock/rspec'
+require 'json'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end
+
+if ENV["COVERAGE"] == 'true'
+  require 'simplecov'
+
+  # add legacy rcov output (so Jenkins/Sonor play well)
+  require 'simplecov-rcov'
+  class SimpleCov::Formatter::MergedFormatter
+    def format(result)
+       SimpleCov::Formatter::HTMLFormatter.new.format(result)
+       SimpleCov::Formatter::RcovFormatter.new.format(result)
+    end
+  end
+  SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+
+  SimpleCov.start
+end
 
 require File.expand_path("../../lib/theplatform", __FILE__)

data/theplatform.gemspec

@@ -1,11 +1,10 @@
-$:.push File.expand_path("../lib", __FILE__)
-require './lib/theplatform.rb'
+version = File.read(File.expand_path("../tpdata_version",__FILE__)).strip
 
 Gem::Specification.new do |s|
   s.name             = 'tpdata'
-  s.version          = ThePlatform::VERSION
+  s.version          = version
   s.date             = '2012-10-03'
-  s.authors          = ['Ben Woodall']
+  s.authors          = ['Ben Woodall, Bryan Stenson']
   s.email            = 'mail@benwoodall.com'
   s.homepage         = 'http://github.com/benwoody/tpdata'
 
@@ -18,8 +17,12 @@ Gem::Specification.new do |s|
 
   s.extra_rdoc_files = ["README.md"]
 
-  s.add_runtime_dependency 'httparty', "~> 0.9.0"
+  s.add_dependency 'httparty', "~> 0.9.0"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'yard'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-rcov'
+
 end

data/tpdata_version

@@ -0,0 +1 @@
+1.1.0

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: tpdata
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
-- Ben Woodall
+- Ben Woodall, Bryan Stenson
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -13,7 +13,7 @@ date: 2012-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &81513660 !ruby/object:Gem::Requirement
+  requirement: &84022590 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *81513660
+  version_requirements: *84022590
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &81512720 !ruby/object:Gem::Requirement
+  requirement: &84022240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *81512720
+  version_requirements: *84022240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &81509950 !ruby/object:Gem::Requirement
+  requirement: &84021660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *81509950
+  version_requirements: *84021660
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &81509500 !ruby/object:Gem::Requirement
+  requirement: &84021210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,40 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *81509500
+  version_requirements: *84021210
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &84020820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *84020820
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &84044910 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *84044910
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: &84043620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *84043620
 description: Tpdata gem is a wrapper for the RESTful interface for thePlatform for
   Media's Data Services.
 email: mail@benwoodall.com
@@ -63,6 +96,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- .gitignore
 - Gemfile
 - Manifest.txt
 - README.md
@@ -78,6 +112,7 @@ files:
 - spec/lib/identity_spec.rb
 - spec/spec_helper.rb
 - theplatform.gemspec
+- tpdata_version
 homepage: http://github.com/benwoody/tpdata
 licenses: []
 post_install_message: