bwapi 10.0.0.pre.549 → 10.0.0

data/lib/bwapi/client/user.rb

@@ -1,4 +1,3 @@
-require 'bwapi/client/user/instagram_credentials'
 require 'bwapi/client/user/notifications'
 
 module BWAPI
@@ -52,7 +51,6 @@ module BWAPI
         user.uiRole
       end
 
-      include BWAPI::Client::User::InstagramCredentials
       include BWAPI::Client::User::Notifications
     end
   end

data/lib/bwapi/configuration.rb

@@ -1,8 +1,8 @@
 module BWAPI
   # Configuration module
   module Configuration
-    attr_accessor :access_token, :access_token_expiry, :adapter, :api_endpoint, :client_id, :debug,
-                  :grant_type, :logger, :performance, :refresh_token, :user_agent, :username, :verify_ssl
+    attr_accessor :access_token, :adapter, :api_endpoint, :client_id, :debug, :grant_type,
+                  :logger, :performance, :refresh_token, :user_agent, :username, :verify_ssl
 
     attr_writer :client_secret, :password
 
@@ -11,7 +11,6 @@ module BWAPI
       def keys
         @keys ||= [
           :access_token,
-          :access_token_expiry,
           :adapter,
           :api_endpoint,
           :client_id,

data/lib/bwapi/default.rb

@@ -26,12 +26,8 @@ module BWAPI
         ENV['BWAPI_ACCESS_TOKEN']
       end
 
-      def access_token_expiry
-        nil
-      end
-
       def adapter
-        ENV['BWAPI_ADAPTER'].is_a?(String) ? ENV['BWAPI_ADAPTER'].to_sym : ADAPTER
+        ENV['BWAPI_ADAPTER'] || ADAPTER
       end
 
       def api_endpoint
@@ -58,7 +54,7 @@ module BWAPI
       end
 
       def debug
-        ENV['BWAPI_DEBUG'] == 'true' ? true : false
+        ENV['BWAPI_DEBUG'] || false
       end
 
       def grant_type
@@ -90,7 +86,7 @@ module BWAPI
       end
 
       def verify_ssl
-        ENV['BWAPI_VERIFY_SSL'] == 'true' ? true : false
+        ENV['BWAPI_VERIFY_SSL'] || false
       end
     end
   end

data/lib/bwapi/error.rb

@@ -25,6 +25,8 @@ module BWAPI
         body
       elsif body.key?('errors')
         body['errors']
+      else
+        nil
       end
     end
 

data/spec/bwapi/client_spec.rb

@@ -1,7 +1,9 @@
 require 'helper'
 
 describe BWAPI::Client do
-  before { BWAPI.reset }
+  before do
+    BWAPI.reset
+  end
 
   describe 'when called' do
     it 'should be a client class instance' do
@@ -10,34 +12,13 @@ describe BWAPI::Client do
   end
 
   describe '.authenticated?' do
-    it 'returns false when not authenticated' do
-      expect(BWAPI::Client.new.authenticated?).to eql(false)
-    end
-
     it 'returns true when authenticated' do
-      bw = BWAPI::Client.new access_token: 'abcdef-ghijkl-123456-789012', access_token_expiry: (Time.now + 3600).iso8601
-      expect(bw.authenticated?).to eql(true)
-    end
-  end
-
-  describe '.access_token_expired?' do
-    it 'returns true if access_token is set to nil' do
-      expect(BWAPI::Client.new.access_token_expired?).to eql(true)
+      expect(BWAPI::Client.new.authenticated?).to eql(false)
     end
 
-    it 'returns true if access_token_expiry is set to nil' do
+    it 'returns false when not authenticated' do
       bw = BWAPI::Client.new access_token: 'abcdef-ghijkl-123456-789012'
-      expect(bw.access_token_expired?).to eql(true)
-    end
-
-    it 'returns true if access token has expired' do
-      bw = BWAPI::Client.new access_token: 'abcdef-ghijkl-123456-789012', access_token_expiry: (Time.now - 3600).iso8601
-      expect(bw.access_token_expired?).to eql(true)
-    end
-
-    it 'returns false if access token has not expired' do
-      bw = BWAPI::Client.new access_token: 'abcdef-ghijkl-123456-789012', access_token_expiry: (Time.now + 3600).iso8601
-      expect(bw.access_token_expired?).to eql(false)
+      expect(bw.authenticated?).to eql(true)
     end
   end
 
@@ -64,10 +45,167 @@ describe BWAPI::Client do
     end
   end
 
-  describe '.seconds_until_access_token_expires' do
-    it 'should return the number of seconds until the access token expires' do
-      bw = BWAPI::Client.new access_token_expiry: (Time.now + 3600).iso8601
-      expect(bw.send(:seconds_until_access_token_expires)).to eql(3600)
+  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 which cannot be accessed' do
+        expect(BWAPI::Client.new.respond_to?(:password)).to eq(false)
+      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 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 which cannot accessed' do
+        expect(BWAPI::Client.new.respond_to?(:client_secret)).to eq(false)
+      end
+
+      it 'should create a logger instance variable' do
+        expect(BWAPI::Client.new.respond_to?(:logger)).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('https://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 '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 allow a user to set a password value' do
+          bw = BWAPI::Client.new password: 'pa55w0rd'
+          expect(bw.instance_eval { @password }).to eql('pa55w0rd')
+        end
+      end
+
+      describe 'grant_type' do
+        it 'should have a default value of api-password for grant_type' do
+          expect(BWAPI::Client.new.grant_type).to eql('api-password')
+        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 allow a user to set a client_secret value' do
+          bw = BWAPI::Client.new client_secret: 'custom_client_secret'
+          expect(bw.instance_eval { @client_secret }).to eql('custom_client_secret')
+        end
+      end
+
+      describe 'logger' do
+        it 'should have a default value of nil for logger' do
+          expect(BWAPI::Client.new.logger).to eql(nil)
+        end
+
+        it 'should allow a user to set a logger value' do
+          logger = Object.new
+          bw = BWAPI::Client.new logger: logger
+          expect(bw.logger).to eql(logger)
+        end
+      end
     end
   end
 end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 10.0.0.pre.549
+  version: 10.0.0
 platform: ruby
 authors:
 - Jonathan Chrisp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2014-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.24.1
 - !ruby/object:Gem::Dependency
   name: allotment
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: faraday
   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: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware-parse_csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware-parse_oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
 description: A Ruby wrapper for the Brandwatch API
@@ -129,10 +129,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .editorconfig
-- .gitignore
-- .rubocop.yml
-- .travis.yml
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -148,35 +148,15 @@ files:
 - lib/bwapi/client/admin/clients/user_groups.rb
 - lib/bwapi/client/admin/clients/users.rb
 - lib/bwapi/client/admin/clients/users/sharing.rb
-- lib/bwapi/client/admin/demographics.rb
 - lib/bwapi/client/admin/search.rb
-- lib/bwapi/client/aggregates.rb
-- lib/bwapi/client/author.rb
 - lib/bwapi/client/brandwatch.rb
 - lib/bwapi/client/brandwatch/become.rb
 - lib/bwapi/client/brandwatch/clients.rb
-- lib/bwapi/client/brandwatch/clients/command_center.rb
-- lib/bwapi/client/brandwatch/clients/command_center/limits.rb
-- lib/bwapi/client/brandwatch/clients/command_center/scene_types.rb
-- lib/bwapi/client/brandwatch/clients/command_center/themes.rb
-- lib/bwapi/client/brandwatch/clients/command_center/users.rb
-- lib/bwapi/client/brandwatch/clients/command_center/users/access.rb
 - lib/bwapi/client/brandwatch/clients/modules.rb
 - lib/bwapi/client/brandwatch/clients/users.rb
-- lib/bwapi/client/brandwatch/command_center.rb
-- lib/bwapi/client/brandwatch/command_center/scene_types.rb
-- lib/bwapi/client/brandwatch/command_center/themes.rb
-- lib/bwapi/client/brandwatch/log_level.rb
-- lib/bwapi/client/brandwatch/price_structures.rb
-- lib/bwapi/client/brandwatch/usage_report.rb
 - lib/bwapi/client/client.rb
 - lib/bwapi/client/command_center.rb
-- lib/bwapi/client/command_center/category_colours.rb
 - lib/bwapi/client/command_center/client.rb
-- lib/bwapi/client/command_center/colour_palette.rb
-- lib/bwapi/client/command_center/display_access.rb
-- lib/bwapi/client/command_center/display_access/users.rb
-- lib/bwapi/client/command_center/display_access/users/access.rb
 - lib/bwapi/client/command_center/displays.rb
 - lib/bwapi/client/command_center/displays/events.rb
 - lib/bwapi/client/command_center/displays/messages.rb
@@ -184,17 +164,10 @@ files:
 - lib/bwapi/client/command_center/displays/screens.rb
 - lib/bwapi/client/command_center/displays/users.rb
 - lib/bwapi/client/command_center/displays/users/access.rb
-- lib/bwapi/client/command_center/projects.rb
-- lib/bwapi/client/command_center/projects/category_colours.rb
-- lib/bwapi/client/command_center/projects/data.rb
-- lib/bwapi/client/command_center/projects/tag_colours.rb
-- lib/bwapi/client/command_center/query_colours.rb
 - lib/bwapi/client/command_center/scene_types.rb
-- lib/bwapi/client/command_center/tag_colours.rb
 - lib/bwapi/client/command_center/themes.rb
 - lib/bwapi/client/command_center/users.rb
 - lib/bwapi/client/command_center/users/access.rb
-- lib/bwapi/client/dimensions.rb
 - lib/bwapi/client/error_codes.rb
 - lib/bwapi/client/filters.rb
 - lib/bwapi/client/languages.rb
@@ -205,24 +178,14 @@ files:
 - lib/bwapi/client/oauth.rb
 - lib/bwapi/client/ping.rb
 - lib/bwapi/client/projects.rb
-- lib/bwapi/client/projects/bulk_actions.rb
-- lib/bwapi/client/projects/bulk_actions/author.rb
-- lib/bwapi/client/projects/bulk_actions/mentions.rb
+- lib/bwapi/client/projects/bulkactions.rb
+- lib/bwapi/client/projects/bulkactions/author.rb
+- lib/bwapi/client/projects/bulkactions/mentions.rb
 - lib/bwapi/client/projects/categories.rb
 - lib/bwapi/client/projects/categories/copy.rb
 - lib/bwapi/client/projects/data.rb
-- lib/bwapi/client/projects/data/audience.rb
-- lib/bwapi/client/projects/data/audience_activity.rb
-- lib/bwapi/client/projects/data/channel_metrics.rb
-- lib/bwapi/client/projects/data/emoticons.rb
-- lib/bwapi/client/projects/data/hashtags.rb
-- lib/bwapi/client/projects/data/headlines.rb
-- lib/bwapi/client/projects/data/impressions.rb
-- lib/bwapi/client/projects/data/mentioned_authors.rb
 - lib/bwapi/client/projects/data/mentions.rb
 - lib/bwapi/client/projects/data/mentions/notes.rb
-- lib/bwapi/client/projects/data/owner_activity.rb
-- lib/bwapi/client/projects/data/urls.rb
 - lib/bwapi/client/projects/data/volume.rb
 - lib/bwapi/client/projects/data_download.rb
 - lib/bwapi/client/projects/demographics.rb
@@ -235,7 +198,6 @@ files:
 - 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/mentionfind.rb
 - lib/bwapi/client/projects/query_groups.rb
 - lib/bwapi/client/projects/rules.rb
 - lib/bwapi/client/projects/rules/backfill.rb
@@ -254,7 +216,6 @@ files:
 - lib/bwapi/client/sso.rb
 - lib/bwapi/client/test_search.rb
 - lib/bwapi/client/user.rb
-- lib/bwapi/client/user/instagram_credentials.rb
 - lib/bwapi/client/user/notifications.rb
 - lib/bwapi/configuration.rb
 - lib/bwapi/connection.rb
@@ -267,8 +228,6 @@ files:
 - lib/bwapi/response/performance.rb
 - lib/bwapi/version.rb
 - spec/bwapi/client_spec.rb
-- spec/bwapi/configuration_spec.rb
-- spec/bwapi/default_spec.rb
 - spec/bwapi_spec.rb
 - spec/helper.rb
 homepage: https://github.com/jonathanchrisp/bwapi
@@ -281,23 +240,22 @@ 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: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Brandwatch API Wrapper
 test_files:
 - spec/bwapi/client_spec.rb
-- spec/bwapi/configuration_spec.rb
-- spec/bwapi/default_spec.rb
 - spec/bwapi_spec.rb
 - spec/helper.rb
+has_rdoc: