bwapi 10.0.0 → 11.0.0.pre.550

data/spec/bwapi/default_spec.rb

@@ -0,0 +1,242 @@
+require 'helper'
+
+describe BWAPI::Default do
+  describe 'constants' do
+    it 'should have an ADAPTER constant with a default value' do
+      expect(BWAPI::Default::ADAPTER).to eql(:net_http)
+    end
+
+    it 'should have an API_ENDPOINT constant with a default value' do
+      expect(BWAPI::Default::API_ENDPOINT).to eql('https://newapi.brandwatch.com/')
+    end
+
+    it 'should have an CLIENT_ID constant with a default value' do
+      expect(BWAPI::Default::CLIENT_ID).to eql('brandwatch-api-client')
+    end
+
+    it 'should have an GRANT_TYPE constant with a default value' do
+      expect(BWAPI::Default::GRANT_TYPE).to eql('api-password')
+    end
+
+    it 'should have an USER_AGENT constant with a default value' do
+      expect(BWAPI::Default::USER_AGENT).to eql("BWAPI Ruby Gem #{BWAPI::VERSION}")
+    end
+  end
+
+  describe '.options' do
+    it 'should return the configuration keys' do
+      expect(BWAPI::Default.options).to eql(
+        access_token: nil,
+        access_token_expiry: nil,
+        adapter: :net_http,
+        api_endpoint: 'https://newapi.brandwatch.com/',
+        client_id: 'brandwatch-api-client',
+        client_secret: nil,
+        connection_options:  {
+          headers:  {
+            user_agent: 'BWAPI Ruby Gem 11.0.0'
+          },
+          request: {
+            params_encoder: Faraday::FlatParamsEncoder
+          }
+        },
+        debug: false,
+        grant_type: 'api-password',
+        logger: nil,
+        password: nil,
+        performance: {},
+        refresh_token: nil,
+        user_agent: 'BWAPI Ruby Gem 11.0.0',
+        username: nil,
+        verify_ssl: false
+      )
+    end
+  end
+
+  describe '.access_token' do
+    after { ENV['BWAPI_ACCESS_TOKEN'] = nil }
+
+    it 'should return nil when no environmental variable is set' do
+      expect(BWAPI::Default.access_token).to eql(nil)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_ACCESS_TOKEN'] = '1234-5678-9101-1234'
+      expect(BWAPI::Default.access_token).to eql('1234-5678-9101-1234')
+    end
+  end
+
+  describe '.access_token_expiry' do
+    it 'should return nil as default' do
+      expect(BWAPI::Default.access_token_expiry).to eql(nil)
+    end
+  end
+
+  describe '.adapter' do
+    after { ENV['BWAPI_ADAPTER'] = nil }
+
+    it 'should return the default value when no environmental variable is set' do
+      expect(BWAPI::Default.adapter).to eql(:net_http)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_ADAPTER'] = 'test'
+      expect(BWAPI::Default.adapter).to eql(:test)
+    end
+  end
+
+  describe '.api_endpoint' do
+    after { ENV['BWAPI_API_ENDPOINT'] = nil }
+
+    it 'should return the default value when no environmental variable is set' do
+      expect(BWAPI::Default.api_endpoint).to eql('https://newapi.brandwatch.com/')
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_API_ENDPOINT'] = 'https://newapi.test.brandwatch.com'
+      expect(BWAPI::Default.api_endpoint).to eql('https://newapi.test.brandwatch.com')
+    end
+  end
+
+  describe '.client_id' do
+    after { ENV['BWAPI_CLIENT_ID'] = nil }
+
+    it 'should return the default value when no environmental variable is set' do
+      expect(BWAPI::Default.client_id).to eql('brandwatch-api-client')
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_CLIENT_ID'] = 'brandwatch-test-client'
+      expect(BWAPI::Default.client_id).to eql('brandwatch-test-client')
+    end
+  end
+
+  describe '.client_secret' do
+    after { ENV['BWAPI_CLIENT_SECRET'] = nil }
+
+    it 'should return nil as default' do
+      expect(BWAPI::Default.client_secret).to eql(nil)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_CLIENT_SECRET'] = 'secret'
+      expect(BWAPI::Default.client_secret).to eql('secret')
+    end
+  end
+
+  describe '.connection_options' do
+    it 'should return the default hash values' do
+      expect(BWAPI::Default.connection_options).to eql(
+        headers: {
+          user_agent: 'BWAPI Ruby Gem 11.0.0'
+        },
+        request: {
+          params_encoder: Faraday::FlatParamsEncoder
+        }
+      )
+    end
+  end
+
+  describe '.debug' do
+    after { ENV['BWAPI_DEBUG'] = nil }
+
+    it 'should return false as default' do
+      expect(BWAPI::Default.debug).to eql(false)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_DEBUG'] = 'true'
+      expect(BWAPI::Default.debug).to eql(true)
+    end
+  end
+
+  describe '.grant_type' do
+    after { ENV['BWAPI_GRANT_TYPE'] = nil }
+
+    it 'should return the default value when no environmental variable is set' do
+      expect(BWAPI::Default.grant_type).to eql('api-password')
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_GRANT_TYPE'] = 'test-grant'
+      expect(BWAPI::Default.grant_type).to eql('test-grant')
+    end
+  end
+
+  describe '.logger' do
+    it 'should return nil as default' do
+      expect(BWAPI::Default.logger).to eql(nil)
+    end
+  end
+
+  describe '.password' do
+    after { ENV['BWAPI_PASSWORD'] = nil }
+
+    it 'should return nil as default' do
+      expect(BWAPI::Default.password).to eql(nil)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_PASSWORD'] = 'p455word'
+      expect(BWAPI::Default.password).to eql('p455word')
+    end
+  end
+
+  describe '.performance' do
+    it 'should return an empty hash as default' do
+      expect(BWAPI::Default.performance).to eql({})
+    end
+  end
+
+  describe '.refresh_token' do
+    after { ENV['BWAPI_REFRESH_TOKEN'] = nil }
+
+    it 'should return nil as default' do
+      expect(BWAPI::Default.refresh_token).to eql(nil)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_REFRESH_TOKEN'] = '1234-5678-9101-1234'
+      expect(BWAPI::Default.refresh_token).to eql('1234-5678-9101-1234')
+    end
+  end
+
+  describe '.user_agent' do
+    after { ENV['BWAPI_USER_AGENT'] = nil }
+
+    it 'should return the default value when no environmental variable is set' do
+      expect(BWAPI::Default.user_agent).to eql("BWAPI Ruby Gem #{BWAPI::VERSION}")
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_USER_AGENT'] = 'Test User Agent'
+      expect(BWAPI::Default.user_agent).to eql('Test User Agent')
+    end
+  end
+
+  describe '.username' do
+    after { ENV['BWAPI_USERNAME'] = nil }
+
+    it 'should return nil as default' do
+      expect(BWAPI::Default.username).to eql(nil)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_USERNAME'] = 'test@brandwatch.com'
+      expect(BWAPI::Default.username).to eql('test@brandwatch.com')
+    end
+  end
+
+  describe '.verify_ssl' do
+    after { ENV['BWAPI_VERIFY_SSL'] = nil }
+
+    it 'should return false as default' do
+      expect(BWAPI::Default.verify_ssl).to eql(false)
+    end
+
+    it 'should return the correct value when the environment variable is set' do
+      ENV['BWAPI_VERIFY_SSL'] = 'true'
+      expect(BWAPI::Default.verify_ssl).to eql(true)
+    end
+  end
+end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 11.0.0.pre.550
 platform: ruby
 authors:
 - Jonathan Chrisp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2015-02-11 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,15 +148,35 @@ 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
@@ -164,10 +184,17 @@ 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
@@ -178,14 +205,24 @@ files:
 - lib/bwapi/client/oauth.rb
 - lib/bwapi/client/ping.rb
 - lib/bwapi/client/projects.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/bulk_actions.rb
+- lib/bwapi/client/projects/bulk_actions/author.rb
+- lib/bwapi/client/projects/bulk_actions/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
@@ -198,6 +235,7 @@ 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
@@ -216,6 +254,7 @@ 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
@@ -228,6 +267,8 @@ 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
@@ -240,22 +281,23 @@ 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 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: