bwapi 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c2e256ae41a00031f7d4c5f62d2cab076b34e80
-  data.tar.gz: d07297df0f274cbe15e42f07492382a3d5b691e7
+  metadata.gz: 7fa06ec6c4a51b3a27fc6c941da930d0f6e588ce
+  data.tar.gz: 198a523090d3905ca38d43c845d8154b7b435798
 SHA512:
-  metadata.gz: 7e6ed60c84b9354250f1e9dead2923020f7b64690d1eada936b9d7acfd590dd006d9e51ad6158abc8f9eee3d9311c3b9b39d3d5c9892b9c676a55ad3b54a8930
-  data.tar.gz: 752d23785c294481eae8e43eeab66ad6089f74dd7bfbca75a6b97ab858c7128237ea0e9c056f1a58c17ef9015601ab979fd4f090c84bb6fe7bf0d6523ce9f1e2
+  metadata.gz: 1c28d816552ab150ef07421c3fe9aaf53e39a538a998d62525692cfa6149ae37a809287a843ef8890cb8df7b6d226c9486160613826b09b372cb4608b04ca6d2
+  data.tar.gz: 587f2f686f7de3f7abd79de7ce8d6ea6af6318ab81616a33679f61d7e0d1e9517ce69b34162c5d9e4d148d54f29c7d2a8a164715af43d0ff91c2153ccbe5ded7

data/lib/bwapi.rb

@@ -3,6 +3,7 @@ require 'bwapi/configuration'
 require 'bwapi/error'
 require 'bwapi/client'
 
+# BWAPI namespace module
 module BWAPI
   extend Configuration
   class << self

data/lib/bwapi/authentication.rb

@@ -1,6 +1,7 @@
 require 'colored'
 
 module BWAPI
+  # Authentication module helper methods
   module Authentication
 
     # Check if user is authenicated

data/lib/bwapi/client.rb

@@ -18,6 +18,7 @@ require 'bwapi/client/test_search'
 require 'bwapi/client/user'
 
 module BWAPI
+  # Client class to create BWAPI instances
   class Client
 
     attr_accessor *Configuration::OPTION_KEYS

data/lib/bwapi/client/admin.rb

@@ -5,6 +5,7 @@ require 'bwapi/client/admin/users'
 
 module BWAPI
   class Client
+    # Admin module for admin endpoints
     module Admin
 
       # Get the active queries irrespective of project

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

@@ -2,6 +2,7 @@ module BWAPI
   class Client
     module Admin
       module Clients
+        # Become module for admin/become endpoint
         module Become
 
           # Become user

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

@@ -2,6 +2,7 @@ module BWAPI
   class Client
     module Admin
       module Clients
+        # Search module for admin/search endpoints
         module Search
 
           # Get a list of queries

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

@@ -2,6 +2,7 @@ module BWAPI
   class Client
     module Admin
       module Clients
+        # Subclients module for admin/subclient endpoints
         module SubClients
 
           # Get all sub clients

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

@@ -4,6 +4,7 @@ module BWAPI
   class Client
     module Admin
       module Clients
+        # Users module for admin/users endpoints
         module Users
 
           # Get all users for client

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

@@ -3,6 +3,7 @@ module BWAPI
     module Admin
       module Clients
         module Users
+          # Sharing module for admin/users/sharing endpoints
           module Sharing
 
             # Get a list of project shares for user

data/lib/bwapi/client/brandwatch.rb

@@ -3,6 +3,7 @@ require 'bwapi/client/brandwatch/client_modules'
 
 module BWAPI
   class Client
+    # Brandwatch module for brandwatch endpoints
     module Brandwatch
 
       # Create a new data download in project

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

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Brandwatch
+      # Become module for brandwatch/become endpoint
       module Become
 
         # Become user

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

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Brandwatch
+      # ClientModules module for brandwatch/clientModules endpoints
       module ClientModules
 
         # Get a specific clients modules

data/lib/bwapi/client/client.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # Client module for client endpoints
     module Client
 
       # Get the current users client

data/lib/bwapi/client/error_codes.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # ErrorCodes module for errorCodes endpoint
     module ErrorCodes
 
       # Get the api error codes

data/lib/bwapi/client/filters.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # Filters module for filters endpoint
     module Filters
 
       # Get the currently supported filters

data/lib/bwapi/client/logout.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # Logout module for logout endpoint
     module Logout
 
       # Logout user

data/lib/bwapi/client/me.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # Me module for me endpoint and helper methods
     module Me
 
       # Get user information

data/lib/bwapi/client/oauth.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # OAuth module for oauth/token endpoint
     module OAuth
 
       # Authenticate a user

data/lib/bwapi/client/ping.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # Ping module for ping endpoints
     module Ping
 
       # Get ping checking access and available HTTP verbs

data/lib/bwapi/client/projects.rb

@@ -13,6 +13,7 @@ require 'bwapi/client/projects/workflow'
 
 module BWAPI
   class Client
+    # Projects module for projects endpoints
     module Projects
 
       # Get all projects

data/lib/bwapi/client/projects/categories.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Categories module for projects/categories endpoints
       module Categories
 
         # Get all categories in project

data/lib/bwapi/client/projects/data.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Data module for project/data endpoints
       module Data
 
         # Get all chart data for the requested dimensions

data/lib/bwapi/client/projects/data_download.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # DataDownload module for projects/datadownload endpoints
       module DataDownload
 
         # Get all data downloads in project

data/lib/bwapi/client/projects/facebook_queries.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # FacebookQueries module for projects/facebookqueries endpoints
       module FacebookQueries
 
         # Get all facebook queries in project

data/lib/bwapi/client/projects/queries.rb

@@ -5,6 +5,7 @@ require 'bwapi/client/projects/queries/mentions'
 module BWAPI
   class Client
     module Projects
+      # Queries module for projects/queries endpoints
       module Queries
 
         # Get all queries in project

data/lib/bwapi/client/projects/queries/backfill.rb

@@ -2,6 +2,7 @@ module BWAPI
   class Client
     module Projects
       module Queries
+        # Backfill module for projects/queries/backfill endpoints
         module Backfill
 
           # Get all backfills for query

data/lib/bwapi/client/projects/queries/date_range.rb

@@ -2,6 +2,7 @@ module BWAPI
   class Client
     module Projects
       module Queries
+        # DateRange module for projects/queries/dateRange endpoints
         module DateRange
 
           # Get all date ranges for query

data/lib/bwapi/client/projects/queries/mentions.rb

@@ -2,6 +2,7 @@ module BWAPI
   class Client
     module Projects
       module Queries
+        # Mentions module for projects/queries/mentions endpoints
         module Mentions
 
           # Get the full text of query mention

data/lib/bwapi/client/projects/query_groups.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # QueryGroups module for projects/queryGroups endpoints
       module QueryGroups
 
         # Get all query groups in project

data/lib/bwapi/client/projects/sharing.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Sharing module for projects/sharing endpoints
       module Sharing
 
         # Default shares of a project

data/lib/bwapi/client/projects/signals.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Signals module for projects/signals endpoints
       module Signals
 
         # Get all signals belonging to user in project

data/lib/bwapi/client/projects/summary.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Summary module for projects/summary endpoints
       module Summary
 
         # Summary of projects

data/lib/bwapi/client/projects/tags.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Tags module for projects/tags endpoints
       module Tags
 
         # Get all tags in project

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

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Users module for projects/users endpoint
       module Users
 
         # Get all users shared with project

data/lib/bwapi/client/projects/workflow.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module Projects
+      # Workflow module for projects/workflow endpoint
       module Workflow
 
         # Get all workflow categories for project

data/lib/bwapi/client/query_validation.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # QueryValidation module for queryValidation endpoints
     module QueryValidation
 
       # Check to see if a query string is valid

data/lib/bwapi/client/sso.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # SSO module for sso endpoint
     module SSO
 
       # Authorize another user for access

data/lib/bwapi/client/test_search.rb

@@ -1,5 +1,6 @@
 module BWAPI
   class Client
+    # TestSearch module for testSearch endpoint
     module TestSearch
 
       # TODO: Uncomment once the endpoint has been fixed

data/lib/bwapi/client/user.rb

@@ -2,6 +2,7 @@ require 'bwapi/client/user/notifications'
 
 module BWAPI
   class Client
+    # User module for user endpoints and helper methods
     module User
 
       # Get the current user

data/lib/bwapi/client/user/notifications.rb

@@ -1,6 +1,7 @@
 module BWAPI
   class Client
     module User
+      # Notifications module for projects/notifications endpoints
       module Notifications
 
         # Get the current user notifications

data/lib/bwapi/configuration.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 
 module BWAPI
+  # Configuration module to set default and custom client credentials
   module Configuration
 
     OPTION_KEYS = [

data/lib/bwapi/connection.rb

@@ -3,6 +3,7 @@ require 'faraday/response/brandwatch_error'
 require 'faraday/utils/utils'
 
 module BWAPI
+  # Connection module to handle requests
   module Connection
     private
 

data/lib/bwapi/request.rb

@@ -1,6 +1,7 @@
 require 'multi_json'
 
 module BWAPI
+  # Request module to handle all requests to API
   module Request
 
     # Perform a get request

data/lib/bwapi/version.rb

@@ -1,3 +1,3 @@
 module BWAPI
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/faraday/response/brandwatch_error.rb

@@ -2,6 +2,7 @@ require 'faraday'
 require 'multi_json'
 
 module Faraday
+  # Response::BrandwatchError class to raise custom faraday middleware errors
   class Response::BrandwatchError < Response::Middleware
     ERROR_MAP = {
       400 => BWAPI::BadRequest,

data/lib/faraday/utils/utils.rb

@@ -3,6 +3,7 @@ require 'faraday'
 # TODO: Remove this patch once latest faraday rc has been released
 # https://github.com/lostisland/faraday/issues/182#issuecomment-19518167
 module Faraday
+  # Overriding Faraday::Utils module build_nested_query method
   module Utils
     def build_nested_query(value, prefix = nil)
       case value

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Jonathan Chrisp