bwapi 1.0.0

data/spec/bwapi/client_spec.rb

@@ -0,0 +1,205 @@
+require 'helper'
+
+describe BWAPI::Client do
+
+  before do
+    BWAPI.reset
+  end
+
+  describe 'when called' do
+    it 'should be a client class instance' do
+      BWAPI::Client.new.should be_an_instance_of BWAPI::Client
+    end
+  end
+
+  describe 'configuration' do
+    describe 'instance variables' do
+      it 'should create a api_endpoint instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:api_endpoint)).to eq(true)
+      end
+
+      it 'should create a user_agent instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:user_agent)).to eq(true)
+      end
+
+      it 'should create a adapter instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:adapter)).to eq(true)
+      end
+
+      it 'should create a username instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:username)).to eq(true)
+      end
+
+      it 'should create a password instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:password)).to eq(true)
+      end
+
+      it 'should create a grant_type instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:grant_type)).to eq(true)
+      end
+
+      it 'should create a access_token instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:access_token)).to eq(true)
+      end
+
+      it 'should create a refresh_token instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:refresh_token)).to eq(true)
+      end
+
+      it 'should create a expires_in instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:expires_in)).to eq(true)
+      end
+
+      it 'should create a client_id instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:client_id)).to eq(true)
+      end
+
+      it 'should create a client_secret instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:client_secret)).to eq(true)
+      end
+
+      it 'should create a netrc instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:netrc)).to eq(true)
+      end
+
+      it 'should create a netrc_file instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:netrc_file)).to eq(true)
+      end
+    end
+
+    describe 'configuration values' do
+      describe 'default_adapter' do
+        it 'should have a default default_adapter value' do
+          expect(BWAPI::Client.new.adapter).to eql(:net_http)
+        end
+
+        it 'should allow a user to set a default_adapter value' do
+          bw = BWAPI::Client.new :adapter => 'custom_adapter'
+          expect(bw.adapter).to eql('custom_adapter')
+        end
+      end
+
+      describe 'user_agent' do
+        it 'should have a default user_agent value' do
+          expect(BWAPI::Client.new.user_agent).to eql("BWAPI Ruby Gem #{BWAPI::VERSION}")
+        end
+
+        it 'should allow a user to set a user_agent value' do
+          bw = BWAPI::Client.new :user_agent => 'custom_user_agent'
+          expect(bw.user_agent).to eql('custom_user_agent')
+        end
+      end
+
+      describe 'api_endpoint' do
+        it 'should have a default api_endpoint value' do
+          expect(BWAPI::Client.new.api_endpoint).to eql("http://newapi.brandwatch.com/")
+        end
+
+        it 'should allow a user to set a api_endpoint value' do
+          bw = BWAPI::Client.new :api_endpoint => 'http://newapi.custom.brandwatch.com'
+          expect(bw.api_endpoint).to eql('http://newapi.custom.brandwatch.com')
+        end
+      end
+
+      describe 'client_id' do
+        it 'should have a default client_id value' do
+          expect(BWAPI::Client.new.client_id).to eql("brandwatch-api-client")
+        end
+
+        it 'should allow a user to set a client_id value' do
+          bw = BWAPI::Client.new :client_id => 'custom_client_id'
+          expect(bw.client_id).to eql('custom_client_id')
+        end
+      end
+
+      describe 'netrc' do
+        it 'should have a default netrc value' do
+          expect(BWAPI::Client.new.netrc).to eql(false)
+        end
+
+        it 'should allow a user to set a netrc value' do
+          bw = BWAPI::Client.new :netrc => true
+          expect(bw.netrc).to eql(true)
+        end
+      end
+
+      describe 'netrc_file' do
+        it 'should have a default netrc value' do
+          expect(BWAPI::Client.new.netrc_file).to eql("#{ENV['HOME'] + '/' + '.netrc'}")
+        end
+
+        it 'should allow a user to set a netrc_file value' do
+          bw = BWAPI::Client.new :netrc_file => 'example/.netrc'
+          expect(bw.netrc_file).to eql('example/.netrc')
+        end
+      end
+
+      describe 'username' do
+        it 'should have a default value of nil for username' do
+          expect(BWAPI::Client.new.username).to eql(nil)
+        end
+
+        it 'should allow a user to set a username value' do
+          bw = BWAPI::Client.new :username => 'jonathan@brandwatch.com'
+          expect(bw.username).to eql('jonathan@brandwatch.com')
+        end
+      end
+
+      describe 'password' do
+        it 'should have a default value of nil for password' do
+          expect(BWAPI::Client.new.password).to eql(nil)
+        end
+
+        it 'should allow a user to set a password value' do
+          bw = BWAPI::Client.new :password => 'pa55w0rd'
+          expect(bw.password).to eql('pa55w0rd')
+        end
+      end
+
+      describe 'grant_type' do
+        it 'should have a default value of nil for grant_type' do
+          expect(BWAPI::Client.new.grant_type).to eql(nil)
+        end
+
+        it 'should allow a user to set a grant_type value' do
+          bw = BWAPI::Client.new :grant_type => 'custom_grant_type'
+          expect(bw.grant_type).to eql('custom_grant_type')
+        end
+      end
+
+      describe 'access_token' do
+        it 'should have a default value of nil for access_token' do
+          expect(BWAPI::Client.new.access_token).to eql(nil)
+        end
+
+        it 'should allow a user to set a access_token value' do
+          bw = BWAPI::Client.new :access_token => 'abcdef-ghijkl-123456-789012'
+          expect(bw.access_token).to eql('abcdef-ghijkl-123456-789012')
+        end
+      end
+
+      describe 'refresh_token' do
+        it 'should have a default value of nil for refresh_token' do
+          expect(BWAPI::Client.new.refresh_token).to eql(nil)
+        end
+
+        it 'should allow a user to set a refresh_token value' do
+          bw = BWAPI::Client.new :refresh_token => 'abcdef-ghijkl-123456-789012'
+          expect(bw.refresh_token).to eql('abcdef-ghijkl-123456-789012')
+        end
+      end
+
+      describe 'client_secret' do
+        it 'should have a default value of nil for client_secret' do
+          expect(BWAPI::Client.new.client_secret).to eql(nil)
+        end
+
+        it 'should allow a user to set a client_secret value' do
+          bw = BWAPI::Client.new :client_secret => 'custom_client_secret'
+          expect(bw.client_secret).to eql('custom_client_secret')
+        end
+      end
+    end
+
+  end
+end

data/spec/bwapi_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe BWAPI do
+
+  describe 'when called' do
+    it 'should be an instance of Module' do
+      BWAPI.should be_an_instance_of Module
+    end
+  end
+
+  describe '.new' do
+    it 'is a BWAPI::Client' do
+      expect(BWAPI.new).to be_a BWAPI::Client
+    end
+  end
+
+  describe '.respond_to?' do
+    it 'returns true if new method exists' do
+      expect(BWAPI.respond_to?(:new, true)).to eq(true)
+    end
+  end
+
+end

data/spec/fixtures/.netrc

@@ -0,0 +1,3 @@
+machine newapi.brandwatch.com
+  login testuser@brandwatch.com
+  password password

data/spec/helper.rb

@@ -0,0 +1,12 @@
+require 'coveralls'
+Coveralls.wear!
+require 'bwapi'
+
+RSpec.configure do |config|
+  config.color_enabled  = true
+  config.formatter      = :documentation
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: bwapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Chrisp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+description: A Ruby wrapper for the Brandwatch v2 API
+email: jonathan@brandwatch.com
+executables:
+- bwapi
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENCE.md
+- README.md
+- bin/bwapi
+- bwapi.gemspec
+- lib/bwapi.rb
+- lib/bwapi/authentication.rb
+- lib/bwapi/client.rb
+- lib/bwapi/client/admin.rb
+- lib/bwapi/client/admin/become.rb
+- lib/bwapi/client/admin/search.rb
+- lib/bwapi/client/admin/sub_clients.rb
+- lib/bwapi/client/admin/users.rb
+- lib/bwapi/client/admin/users/sharing.rb
+- lib/bwapi/client/brandwatch.rb
+- lib/bwapi/client/brandwatch/become.rb
+- lib/bwapi/client/brandwatch/client_modules.rb
+- lib/bwapi/client/client.rb
+- lib/bwapi/client/error_codes.rb
+- lib/bwapi/client/filters.rb
+- lib/bwapi/client/logout.rb
+- lib/bwapi/client/me.rb
+- lib/bwapi/client/oauth.rb
+- lib/bwapi/client/ping.rb
+- lib/bwapi/client/projects.rb
+- lib/bwapi/client/projects/categories.rb
+- lib/bwapi/client/projects/data.rb
+- lib/bwapi/client/projects/data_download.rb
+- lib/bwapi/client/projects/facebook_queries.rb
+- lib/bwapi/client/projects/queries.rb
+- lib/bwapi/client/projects/queries/backfill.rb
+- lib/bwapi/client/projects/queries/date_range.rb
+- lib/bwapi/client/projects/queries/mentions.rb
+- lib/bwapi/client/projects/query_groups.rb
+- lib/bwapi/client/projects/sharing.rb
+- lib/bwapi/client/projects/signals.rb
+- lib/bwapi/client/projects/summary.rb
+- lib/bwapi/client/projects/tags.rb
+- lib/bwapi/client/projects/users.rb
+- lib/bwapi/client/projects/workflow.rb
+- lib/bwapi/client/query_validation.rb
+- lib/bwapi/client/sso.rb
+- lib/bwapi/client/test_search.rb
+- lib/bwapi/client/user.rb
+- lib/bwapi/client/user/notifications.rb
+- lib/bwapi/configuration.rb
+- lib/bwapi/connection.rb
+- lib/bwapi/error.rb
+- lib/bwapi/request.rb
+- lib/bwapi/version.rb
+- lib/faraday/response/brandwatch_error.rb
+- lib/faraday/utils/utils.rb
+- spec/bwapi/authentication_spec.rb
+- spec/bwapi/client_spec.rb
+- spec/bwapi_spec.rb
+- spec/fixtures/.netrc
+- spec/helper.rb
+homepage: https://github.com/jonathanchrisp/bwapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Brandwatch v2 API Wrapper
+test_files:
+- spec/bwapi/authentication_spec.rb
+- spec/bwapi/client_spec.rb
+- spec/bwapi_spec.rb
+- spec/fixtures/.netrc
+- spec/helper.rb