bwapi 9.0.0.pre.390 → 9.0.0.pre.401

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDE0NDgzNmJkY2Q2OGY1OGU1OTc0ZGZiYmI2YjczNDk1NWM2N2FhMg==
+    OTI1MjNmMWIzNjJlYjc5NzU3MTkwYWZjNWZmYjg4MTkzM2FkZDdjZg==
   data.tar.gz: !binary |-
-    NTI3NDg5YWQ5MjEzNWU1NTk1ZTJjZWE1OTkwNzYzYTVmZDEzN2M3MQ==
+    YTNlZWMzYzU3Mjk4OWY0ZDgwYWI0MDNjNzFmODY0YmQxMzg2MGY0Ng==
 SHA512:
   metadata.gz: !binary |-
-    YzQwZTZlNjI3YWQwNGFiNmEwYzBmNzc2MDk0ODhhOTJhMzk5YzVkNWMzYjJk
-    N2Y5Zjk4MjYyZjQ5ODNkYjNjMjYxYWIyMDNlNDAzYTRhNjM0MWVkMTQ4YmIy
-    ZDYxNjExOGZkMmU5YTRjZmY0MGM2NWU0MTFhOTk0OTliMzZkNjc=
+    Y2I3MDc4Yzk0NjE1NGFmZDljYTVhMzE1MDhmYjgyYmYxZWZkODMyYzc3NzAy
+    MGM4NGRkYTQ4ZTZhNTg1YzZmMThiNDJlYmZkOTA4N2E3ZjdlMTNiM2Y1ZTgz
+    ODE4OWEyMGNhOWZlZTIxNmQ5MzNlZGFlNTc2Yzg4ZmFjMzBmZDA=
   data.tar.gz: !binary |-
-    YTQyMjg3Yjc0MDI0ZmY3ZDJlYzVlMzc1YzZlOWQ0ZTQyYWM5ZGZmZWZkNjUw
-    NTg5ZDg0MTM0ZDhjNGNkOGJlMzkzMDlhZDI5ZDQyMTg0YjgyNDQxNzdhYThl
-    YWFjNGRkNTU3MmE2Mzk2Y2E4OTllMjE0MTI0YThlZWRhMjY1MDc=
+    ZjQ3MmQ2MDJhY2NlYmE4ZTZmYjJkZDY1YmJkNzJlMDkyNTg3Y2NiNTE0NWI0
+    YjFlNTY5MzU1NjE1ZjRlYjQ1ODQ4MDNiMzg0YjU0YTQ2ODJjNjhjZTBkNWY3
+    YTMxMTg1ODhjNjMyNGJiNjc3NDJlNDRlNGE1MDJmOWNmMDY3NTE=

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## 9.0.0
+### Added
+* NoTask - updated notifications endpoints to match new structure
+* NoTask - refactored configuration and defaults classes
+* NoTask - removed hashie middleware in favour of OJ for improved performance
+* NoTask - Implemented signals groups endpoints
+* NoTask - Implemented mention notes endpoints
+* #112 - Create logger middleware
+* #113 - Create performance middleware
+* #129 - Update README.md following latest updates
+* #130 - Add separate CONTRIBUTING.md and CHANGELOG.md
+* #133 - Updated method comments to return Hash instead of Hashie::Mash
+
+### Fixed
+* NoTask - remove unwanted opts from mentions note get request

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+If you would like to contribute to this project please fork the repo and follow the guidelines below:
+
+1. Create an issue outlining the feature or bug
+2. Once approved/confirmed create a new branch from the staging branch
+3. Once your feature has been implemented ensure:
+  * Exisiting RSpec unit tests still pass
+  * No [Rubocop](https://github.com/bbatsov/rubocop) offenses have been introduced
+4. Create a new pull request merging into the staging branch (unit and rubocop tests will automatically run on travis)
+5. Update PR if the code reviewer returns comments or tests fail in step above
+6. Once merged the gem version + gemspec date will be updated and merged into the master branch
+7. Travis will create a pre release gem on any merge into the master branch
+8. Once the pre release gem is tested and approved the new gem version will be pushed to rubygems

data/README.md

@@ -5,16 +5,13 @@
 [![Coverage Status](https://coveralls.io/repos/jonathanchrisp/bwapi/badge.png?branch=master)](https://coveralls.io/r/jonathanchrisp/bwapi?branch=master)
 
 # bwapi
-
-__PLEASE NOTE THAT THIS PROJECT IS NOT OFFICIALLY SUPPORTED BY BRANDWATCH__
-
-A Ruby interface to the Brandwatch V2 API.
+A Ruby interface to the Brandwatch API.
 
 ## Documentation
 http://rubydoc.info/gems/bwapi/
 
 ## Getting Started
-All Brandwatch API calls at present require you to be authenticated, therefore you'll need to create an instance of a client and call login immediately:
+All Brandwatch API calls at present require you to be authenticated, therefore you'll need to create an instance of a bwapi client and call the login method immediately:
 
 ```ruby
 bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd')
@@ -24,35 +21,35 @@ bw.login
 The API returns the oauth/token response with your authentication details.
 
 ## Examples
+Once authenticated, you are then able to make additional requests. The bwapi gem will automatically add your access token to subsequent request headers.
 
-Once authenticated, you are then able to make additional requests. The bwapi gem will automatically add your clients access token to the request header. Please see some examples of API requests below:
+Please see an example projects response below:
 
-### Request all projects
 ```ruby
 bw.projects
-=> #<Hashie::Mash results=[#<Hashie::Mash clientId=1856278873 clientName="JC BWAPI Demo" creationDate="2013-07-24T17:56:31.074+0000" creatorUserId=158304410 defaultIndustry="general-(recommended)" defaultLangCodes=["en"] description=nil id=1856280126 links=#<Hashie::Mash queries="http://newapi.brandwatch.com//projects/1856280126/queries.json?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f"> name="Demo Project">] resultsPage=-1 resultsPageSize=-1 resultsTotal=-1>
-```
-
-### Request a specific project
-```ruby
-bw.project 1856280126
-=> #<Hashie::Mash clientId=1856278873 clientName="JC BWAPI Demo" creationDate="2013-07-24T17:56:31.074+0000" creatorUserId=158304410 defaultIndustry="general-(recommended)" defaultLangCodes=["en"] description=nil id=1856280126 links=#<Hashie::Mash queries="http://newapi.brandwatch.com//projects/1856280126/queries.json?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f"> name="Demo Project">
-```
-
-### Request a project queries summary
-```ruby
-bw.queries_summary 1856280126
-=> #<Hashie::Mash results=[#<Hashie::Mash id=1856280351 name="LA Lakers">] resultsPage=-1 resultsPageSize=-1 resultsTotal=-1>
-```
-
-### Request user information
-```ruby
-bw.me
-=> #<Hashie::Mash client=#<Hashie::Mash id=1856278873 name="JC BWAPI Demo" parentId=-1 railsEnabled=false theme="brandwatch"> firstName="BWAPI" id=158304410 lastName="Demo" links=#<Hashie::Mash logout="http://newapi.brandwatch.com/logout?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f" user="http://newapi.brandwatch.com//user.json?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f"> tags=#<Hashie::Mash notify="true"> uiRole="admin" username="bwapi_demo=jonathan@brandwatch.com">
+{
+  "resultsTotal"=>-1,
+  "resultsPage"=>-1,
+  "resultsPageSize"=>-1,
+  "results"=>[
+    { "id"=>1856280126,
+      "name"=>"Demo Project",
+      "description"=>nil,
+      "clientId"=>1856278873,
+      "defaultLangCodes"=>["en"],
+      "defaultIndustry"=>"general-(recommended)",
+      "creatorUserId"=>158304410,
+      "creationDate"=>"2013-07-24T17:56:31.074+0000",
+      "links"=> {
+        "queries"=>"http://newapi.brandwatch.com//projects/1856280126/queries.json?access_token=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+      },
+      "clientName"=>"JC BWAPI Demo"
+    }
+  ]
+}
 ```
 
 ## Debug Mode
-
 In order to see additional logging and performance information you can enable debug mode by passing this in as an option when creating your client instance:
 
 ```ruby
@@ -60,7 +57,6 @@ bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd', d
 ```
 
 ### Logging
-
 Any log output will be written to STDOUT unless you define a logger:
 
 ```ruby
@@ -68,20 +64,20 @@ bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd', d
 ```
 
 ### Performance
-
-When debug mode is running each response time and stored, to view the stats call the performance method on the client instance:
+When debug mode is running the response performance is stored on each require, to view the stats call the performance method on the client instance:
 
 ```ruby
 bw.performance
-{"post_oauth_token"=>[0.125019], "get_me"=> [0.048003, 0.034587, 0.038165, 0.10304]}
+{
+  "post_oauth_token"=>[0.125019],
+  "get_me"=> [0.048003, 0.034587, 0.038165, 0.10304]
+}
 ```
 
 Please note that only successful responses are recorded. Any request which raises an error is ignored.
 
 ## Contributing
-If you would like to contribute to this project please fork, create your new feature and then submit a PR merging into the `staging` branch. Once the feature is merged I'll update the version number and date in the gemspec and merge to master.
-
-Once the staging branch is merged into master a pre-release gem will automatically be created via travis. Subject to no issues being found the new version of the gem will be pushed to RubyGems.
+If you would like to contribute to this project please see the [contributing guidelines](https://github.com/jonathanchrisp/bwapi/blob/staging/CONTRIBUTING.md).
 
 ## Tests
 There are a number of unit tests which are included as part of this project, please run:

data/bwapi.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.name        = 'bwapi'
   s.version     = BWAPI::VERSION
   s.version     = BWAPI::VERSION + ".pre.#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
-  s.date        = '2014-08-04'
+  s.date        = '2014-08-28'
   s.summary     = 'Brandwatch API Wrapper'
   s.description = 'A Ruby wrapper for the Brandwatch API'
   s.author      = 'Jonathan Chrisp'

data/lib/bwapi/client/admin.rb

@@ -13,14 +13,14 @@ module BWAPI
       # @option opts [Integer] page Page of projects to retrieve
       # @option opts [Integer] pageSize Results per page of results
       # @option opts [Integer] sortBy Filter to sort queries by
-      # @return [Hashie::Mash] All active queries
+      # @return [Hash] All active queries
       def active_queries(opts = {})
         get 'admin/activequeries', opts
       end
 
       # Get the project report of sharing details
       #
-      # @return [Hashie::Mash] Project sharing report
+      # @return [Hash] Project sharing report
       def sharing_report
         get 'admin/sharing-report'
       end

data/lib/bwapi/client/admin/become.rb

@@ -9,7 +9,7 @@ module BWAPI
           # @note must be a client admin user
           #
           # @param user_id [Integer] The user id
-          # @return [Hashie::Mash] User credentials
+          # @return [Hash] User credentials
           def admin_become(user_id)
             get "admin/become/#{user_id}"
           end

data/lib/bwapi/client/admin/search.rb

@@ -8,7 +8,7 @@ module BWAPI
           #
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
-          # @return [Hashie::Mash] List of queries
+          # @return [Hash] List of queries
           def search_query_text(opts = {})
             get 'admin/search/querytext', opts
           end
@@ -17,7 +17,7 @@ module BWAPI
           #
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
-          # @return [Hashie::Mash] List of query names
+          # @return [Hash] List of query names
           def search_query_name(opts = {})
             get 'admin/search/queryname', opts
           end
@@ -26,7 +26,7 @@ module BWAPI
           #
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
-          # @return [Hashie::Mash] List of rules
+          # @return [Hash] List of rules
           def search_rule_text(opts = {})
             get 'admin/search/ruletext', opts
           end

data/lib/bwapi/client/admin/sub_clients.rb

@@ -10,7 +10,7 @@ module BWAPI
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] page Page of projects to retrieve
           # @option opts [Integer] pageSize Results per page of results
-          # @return [Hashie::Mash] All sub clients for client
+          # @return [Hash] All sub clients for client
           def client_sub_clients(client_id, opts = {})
             get "admin/clients/#{client_id}/subclients", opts
           end
@@ -19,7 +19,7 @@ module BWAPI
           #
           # @param client_id [Integer] Id of the client
           # @param sub_client_id [Integer] Id of the sub client
-          # @return [Hashie::Mash] Specific sub client for client
+          # @return [Hash] Specific sub client for client
           def get_client_sub_client(client_id, sub_client_id)
             get "admin/clients/#{client_id}/subclients/#{sub_client_id}"
           end
@@ -54,7 +54,7 @@ module BWAPI
           # @option opts [String] contactName The contact name of the client
           # @option opts [Integer] maximumSubscribedBrands The maximum subscribed brands for the client
           # @option opts [String] contactMobile The mobile number for the client
-          # @return [Hashie::Mash] New sub client
+          # @return [Hash] New sub client
           def create_client_sub_client(client_id, opts = {})
             post "admin/clients/#{client_id}/subclients", opts
           end
@@ -90,7 +90,7 @@ module BWAPI
           # @option opts [String] contactName The contact name of the client
           # @option opts [Integer] maximumSubscribedBrands The maximum subscribed brands for the client
           # @option opts [String] contactMobile The mobile number for the client
-          # @return [Hashie::Mash] Edited sub client
+          # @return [Hash] Edited sub client
           def update_client_sub_client(client_id, sub_client_id, opts = {})
             put "admin/clients/#{client_id}/subclients/#{sub_client_id}", opts
           end
@@ -99,7 +99,7 @@ module BWAPI
           #
           # @param client_id [Integer] Id of the client
           # @param sub_client_id [Integer] Id of the sub client
-          # @return [Hashie::Mash] Specific sub client for client
+          # @return [Hash] Specific sub client for client
           def delete_client_sub_client(client_id, sub_client_id)
             delete "admin/clients/#{client_id}/subclients/#{sub_client_id}"
           end

data/lib/bwapi/client/admin/users.rb

@@ -12,7 +12,7 @@ module BWAPI
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] page Page of projects to retrieve
           # @option opts [Integer] pageSize Results per page of results
-          # @return [Hashie::Mash] All client users
+          # @return [Hash] All client users
           def client_users(client_id, opts = {})
             get "admin/clients/#{client_id}/users", opts
           end
@@ -21,7 +21,7 @@ module BWAPI
           #
           # @param client_id [Integer] Id of the client
           # @param user_id [Integer] Id of the user
-          # @return [Hashie::Mash] Specific client user
+          # @return [Hash] Specific client user
           def get_client_user(client_id, user_id)
             get "admin/clients/#{client_id}/users/#{user_id}"
           end
@@ -48,7 +48,7 @@ module BWAPI
           # @option opts [String] firstName The users first name
           # @option opts [String] mobile The users mobile number
           # @option opts [Date] creationDate Date the user was created on
-          # @return [Hashie::Mash] New user
+          # @return [Hash] New user
           def create_client_user(client_id, opts = {})
             post "admin/clients/#{client_id}/users", opts
           end
@@ -76,7 +76,7 @@ module BWAPI
           # @option opts [String] firstName The users first name
           # @option opts [String] mobile The users mobile number
           # @option opts [Date] creationDate Date the user was created on
-          # @return [Hashie::Mash] New user
+          # @return [Hash] New user
           def update_client_user(client_id, user_id, opts = {})
             put "admin/clients/#{client_id}/users/#{user_id}", opts
           end

data/lib/bwapi/client/admin/users/sharing.rb

@@ -9,7 +9,7 @@ module BWAPI
             #
             # @param client_id [Integer] Id of the client
             # @param user_id [Integer] Id of the user
-            # @return [Hashie::Mash] All shares for client user
+            # @return [Hash] All shares for client user
             def client_users_sharing(client_id, user_id)
               get "admin/client/#{client_id}/users/#{user_id}/sharing"
             end
@@ -20,7 +20,7 @@ module BWAPI
             # @param user_id [Integer] Id of the user
             # @param opts [Hash] options Hash of parameters
             # @option opts [Array] ProjectShareDTO The shares of the user
-            # @return [Hashie::Mash] Updated shares for client user
+            # @return [Hash] Updated shares for client user
             def update_client_users_sharing(client_id, user_id, opts)
               get "admin/client/#{client_id}/users/#{user_id}/sharing", opts
             end

data/lib/bwapi/client/brandwatch.rb

@@ -19,7 +19,7 @@ module BWAPI
       # @option opts [String] downloadLinkXLS The link to download the XLS format
       # @option opts [String] downloadLinkCSV The link to download the CSV format
       # @option opts [Array] additionalColumns The additional columns for the data download
-      # @return [Hashie::Mash] New data download
+      # @return [Hash] New data download
       def brandwatch_data_download(project_id, opts = {})
         post "brandwatch/#{project_id}/datadownload", opts
       end

data/lib/bwapi/client/brandwatch/become.rb

@@ -8,7 +8,7 @@ module BWAPI
         # @note must be a super admin user
         #
         # @param user_id [Integer] The user id
-        # @return [Hashie::Mash] User credentials
+        # @return [Hash] User credentials
         def brandwatch_become(user_id)
           get "brandwatch/become/#{user_id}"
         end

data/lib/bwapi/client/brandwatch/client_modules.rb

@@ -6,7 +6,7 @@ module BWAPI
         # Get a specific clients modules
         #
         # @param client_id [Integer] Id of the client
-        # @return [Hashie::Mash] Specific clients modules
+        # @return [Hash] Specific clients modules
         def brandwatch_client_modules(client_id)
           get "brandwatch/clientModules/#{client_id}"
         end
@@ -15,7 +15,7 @@ module BWAPI
         #
         # @param opts [Hash] options Hash of parameters
         # @option opts [Array] ClientModules Client Modules to edit
-        # @return [Hashie::Mash] Update client modules
+        # @return [Hash] Update client modules
         def update_brandwatch_client_module(opts = {})
           put 'brandwatch/clientModules', opts
         end

data/lib/bwapi/client/client.rb

@@ -4,14 +4,14 @@ module BWAPI
     module Client
       # Get the current users client
       #
-      # @return [Hashie::Mash] Client information
+      # @return [Hash] Client information
       def client
         get 'client'
       end
 
       # Get the current users client modules
       #
-      # @return [Hashie::Mash] Client module information
+      # @return [Hash] Client module information
       def client_modules
         get 'client/modules'
       end

data/lib/bwapi/client/command_center/client.rb

@@ -5,7 +5,7 @@ module BWAPI
       module Client
         # Get vizia client information
         #
-        # @return [Hashie::Mash] All themes
+        # @return [Hash] All themes
         def vizia_client
           get 'commandcenter/client'
         end

data/lib/bwapi/client/command_center/displays.rb

@@ -11,7 +11,7 @@ module BWAPI
       module Displays
         # Get the displays visible to the user
         #
-        # @return [Hashie::Mash] All displays
+        # @return [Hash] All displays
         def displays
           get 'commandcenter/displays'
         end
@@ -19,7 +19,7 @@ module BWAPI
         # Get an existing display
         #
         # @param [Integer] display_id the display id
-        # @return [Hashie::Mash] Specific display
+        # @return [Hash] Specific display
         def get_display(display_id)
           get "commandcenter/displays/#{display_id}"
         end
@@ -34,7 +34,7 @@ module BWAPI
         # @option opts [Boolean] active Whether display is active
         # @option opts [String] created Date display was created
         # @option opts [Boolean] enabled Whether display is enabled
-        # @return [Hashie::Mash] New display
+        # @return [Hash] New display
         def create_display(opts = {})
           post 'commandcenter/displays', opts
         end
@@ -50,7 +50,7 @@ module BWAPI
         # @option opts [Boolean] active Whether display is active
         # @option opts [String] created Date display was created
         # @option opts [Boolean] enabled Whether display is enabled
-        # @return [Hashie::Mash] Updated display
+        # @return [Hash] Updated display
         def update_display(display_id, opts = {})
           put "commandcenter/displays/#{display_id}", opts
         end
@@ -58,7 +58,7 @@ module BWAPI
         # Delete an existing display
         #
         # @param [Integer] display_id the display id
-        # @return [Hashie::Mash] Deleted display
+        # @return [Hash] Deleted display
         def delete_display(display_id)
           delete "commandcenter/displays/#{display_id}"
         end