bwapi 6.5.0.pre.256 → 7.0.0.pre.271

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzIwY2M1NmRjOWYyMmM1NTdmMjkyM2Q4ZDdmNjU3MWM3Njc5ZjVkYQ==
+    ZDU2NzRiMjIwYjU0MjQwN2VlMGUzNzZiZmMwNTA5NjMxODJlZTA4Mg==
   data.tar.gz: !binary |-
-    NmNjZmFmMDUwNjRmY2I5YWI1MmEzZjc0MDRiZWMyMDA4ODZiZThlZA==
+    YTVlYTNlZjM1NTA2NzA4MmU0YWQwOWFlYjM5NjRlNjQ0Nzc2YzNmYw==
 SHA512:
   metadata.gz: !binary |-
-    MTE2ZmE0M2QxNDQ3Nzg3NzYzZDUzMGYzOTk4NDlkYmIyNjk0NmRkZTlmZjA3
-    YjQ2YWI1MDRjMmY0MDk5YTdjNTMxNmE1MjFiNGNiNmNlMGEyNzRjNDYxMjdi
-    ODllYWMwOTA5MzAzNzBlYjlkNmZlZWQ2MWVjMmY2ZmVlMGZmNjQ=
+    NDIxNWIwNTNmZmVkMzdmN2FkNDI0MGM5N2I2NzAwZmY4NjE5NThiYTU4OWVh
+    YWI5OTM3NTg3NzRlZDI1MTc1ZTY4MjczMWFhZDI4YjUwZDY3YzQxNGRmMjNj
+    ODJlYjlmY2Y4ZmI2YmI3Y2FiMDNjYzI5Njc0MDIwZTlmZjQxMzM=
   data.tar.gz: !binary |-
-    NWZlNWFlZDAwMjM1OWFiZDY0MTE5MDZiZjYyYWZhZDgxNGU0MGFlZjYzNzU2
-    YzM5Njc3MzY0MWFmYTliYmVmZDE0ZjJjYzM4ZmYyZjk1MDlkZjUzNzZlZGVl
-    ODVhYTEwMmFjZWVmODQ3YWM4Yjc4MjE1Nzg2Njk1MmRlM2VmYTk=
+    MmU4MzViODAxNDliM2M4OTQ1YmNmZjViMDc2MzNkN2I1YTE4ZDMwZTFmZjAx
+    NjVjZmRhZTliNmU1Y2Y3MmUzMGJjYmFjYjMwYmZlMTYwZDNhOGZkMzA4ZTA4
+    NjUxYzRlYzliNmIwOTYzYTI5MjRiMjEyYjFjYjJkOGY4YzdjNzQ=

data/.editorconfig

@@ -0,0 +1,11 @@
+# EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_style = spaces
+indent_size = 2

data/.rubocop.yml

@@ -0,0 +1,17 @@
+# See full list of defaults here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# To see all cops used see here: https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+
+LineLength:
+  Max: 150
+
+MethodLength:
+  Max: 30
+
+CyclomaticComplexity:
+  Max: 15
+
+AccessorMethodName:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false

data/.travis.yml

@@ -1,13 +1,17 @@
 language: ruby
+cache: bundler
 rvm:
+- 2.1.0
 - 2.0.0
 - 1.9.3
 - 1.9.2
 
 before_script:
-- chmod 600 spec/fixtures/.netrc
+  - chmod 600 spec/fixtures/.netrc
 
-script: bundle exec rspec spec
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec
 
 deploy:
   provider: rubygems
@@ -15,4 +19,4 @@ deploy:
     secure: g7xKyeiMs2o1HLokzOWCiLKxmTaEmuQDB0he9kxFhjqMLbRQHu1pVL0uE2bD0K/zq8Ebb+OPchVmej/6s5Be97AOK5d1wGdBAhXISwlxPoXxLJ6zU5DF1vjF3YCZK197z81ATcGcocsD2eYXZ4NzJcI+FW3kzO6QQhfHfUUeHvM=
   gem: bwapi
   on:
-    repo: jonathanchrisp/bwapi
+    repo: jonathanchrisp/bwapi

data/bin/bwapi

@@ -1,2 +1,3 @@
 #!/usr/bin/env ruby
-require 'bwapi'
+# encoding: utf-8
+require 'bwapi'

data/bwapi.gemspec

@@ -1,4 +1,6 @@
-require File.dirname(__FILE__) + "/lib/bwapi/version"
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/lib/bwapi/version'
 
 Gem::Specification.new do |s|
   s.name        = 'bwapi'
@@ -11,19 +13,20 @@ Gem::Specification.new do |s|
   s.email       = 'jonathan@brandwatch.com'
   s.license     = 'MIT'
   s.homepage    = 'https://github.com/jonathanchrisp/bwapi'
-  s.required_ruby_version = ">= 1.9.2"
+  s.required_ruby_version = '>= 1.9.2'
 
-  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'rspec', '~> 2.14.1', '>= 2.14.1'
+  s.add_development_dependency 'rubocop', '~> 0.21.0', '>= 0.21.0'
 
   s.add_runtime_dependency 'colored', '~> 1.2'
-  s.add_runtime_dependency 'faraday', '~> 0.8.7'
-  s.add_runtime_dependency 'faraday_middleware', '~> 0.9.0'
-  s.add_runtime_dependency 'hashie', '~> 2.0.5'
-  s.add_runtime_dependency 'multi_json', '~> 1.9.0'
-  s.add_runtime_dependency 'netrc', '~> 0.7.7'
+  s.add_runtime_dependency 'faraday', '~> 0.9.0', '>= 0.9.0'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.9.0', '>= 0.9.0'
+  s.add_runtime_dependency 'hashie', '~> 2.0.5', '>= 2.0.5'
+  s.add_runtime_dependency 'multi_json', '~> 1.9.0', '>= 1.9.0'
+  s.add_runtime_dependency 'netrc', '~> 0.7.7', '>= 0.7.7'
 
   s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
-end
+end

data/lib/bwapi.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/version'
 require 'bwapi/configuration'
 require 'bwapi/error'
@@ -7,23 +9,21 @@ require 'bwapi/client'
 module BWAPI
   extend Configuration
   class << self
-
     # Alias for BWAPI::Client.new
     #
     # @return [BWAPI::Client]
-    def new opts={}
+    def new(opts = {})
       BWAPI::Client.new opts
     end
 
     # Delegate to BWAPI::Client.new
-    def method_missing method, *args, &block
+    def method_missing(method, *args, &block)
       return super unless new.respond_to? method
       new.send method, *args, &block
     end
 
-    def respond_to? method, include_private=false
+    def respond_to?(method, include_private = false)
       new.respond_to?(method, include_private) || super(method, include_private)
     end
-
   end
-end
+end

data/lib/bwapi/authentication.rb

@@ -1,42 +1,35 @@
+# encoding: utf-8
+
 require 'colored'
 
 module BWAPI
   # Authentication module helper methods
   module Authentication
-
     # Check if user is authenicated
     #
     # @return [Boolean] Authenticated status
     def authenticated?
-      !!access_token
+      access_token ? true : false
     end
 
     # Check if user is a brandwatch-application-client type
     #
     # @return [Boolean] Application client status
     def application_client?
-      if client_id == 'brandwatch-application-client'
-        true
-      else
-        false
-      end
+      client_id == 'brandwatch-application-client' ? true : false
     end
 
     # Check if user is a brandwatch-api-client type
     #
     # @return [Boolean] Application client status
     def api_client?
-      if client_id == 'brandwatch-api-client'
-        true
-      else
-        false
-      end
+      client_id == 'brandwatch-api-client' ? true : false
     end
 
     # Set username and password via netrc
     #
     # @param netrc [Boolean] Netrc status
-    def netrc_credentials netrc=false
+    def netrc_credentials(netrc = false)
       return unless netrc
 
       require 'netrc'
@@ -45,12 +38,11 @@ module BWAPI
       # Get credentials using host
       netrc_host = URI.parse(api_endpoint).host
       creds = file[netrc_host]
-      raise 'You are missing your .netrc file or the host provided has no credentials!'.red.underline if creds.nil?
+      fail 'You are missing your .netrc file or the host provided has no credentials!'.red.underline if creds.nil?
       self.username = creds.shift
       self.password = creds.shift
     rescue LoadError
-      raise "Please install netrc gem for .netrc support".red.underline
+      raise 'Please install netrc gem for .netrc support'.red.underline
     end
-
   end
-end
+end

data/lib/bwapi/client.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/authentication'
 require 'bwapi/connection'
 require 'bwapi/request'
@@ -24,10 +26,9 @@ require 'bwapi/client/user'
 module BWAPI
   # Client class to create BWAPI instances
   class Client
+    attr_accessor(*Configuration::OPTION_KEYS)
 
-    attr_accessor *Configuration::OPTION_KEYS
-
-    def initialize opts={}
+    def initialize(opts = {})
       opts = BWAPI.options.merge opts
       Configuration::OPTION_KEYS.each do |k|
         send "#{k}=", opts[k]
@@ -59,4 +60,4 @@ module BWAPI
     include BWAPI::Client::TestSearch
     include BWAPI::Client::User
   end
-end
+end

data/lib/bwapi/client/admin.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/client/admin/become'
 require 'bwapi/client/admin/search'
 require 'bwapi/client/admin/sub_clients'
@@ -7,7 +9,6 @@ module BWAPI
   class Client
     # Admin module for admin endpoints
     module Admin
-
       # Get the active queries irrespective of project
       #
       # @param opts [Hash] options hash of parameters
@@ -15,22 +16,21 @@ module BWAPI
       # @option opts [Integer] pageSize Results per page of results
       # @option opts [Integer] sortBy Filter to sort queries by
       # @return [Hashie::Mash] All active queries
-      def active_queries opts={}
-        get "admin/activequeries", opts
+      def active_queries(opts = {})
+        get 'admin/activequeries', opts
       end
 
       # Get the project report of sharing details
       #
       # @return [Hashie::Mash] Project sharing report
       def sharing_report
-        get "admin/sharing-report"
+        get 'admin/sharing-report'
       end
 
       include BWAPI::Client::Admin::Clients::Become
       include BWAPI::Client::Admin::Clients::SubClients
       include BWAPI::Client::Admin::Clients::Search
       include BWAPI::Client::Admin::Clients::Users
-
     end
   end
-end
+end

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

@@ -1,22 +1,22 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Admin
       module Clients
         # Become module for admin/become endpoint
         module Become
-
           # Become user
           #
           # @note must be a client admin user
           #
           # @param user_id [Integer] The user id
           # @return [Hashie::Mash] User credentials
-          def admin_become user_id
+          def admin_become(user_id)
             get "admin/become/#{user_id}"
           end
-
         end
       end
     end
   end
-end
+end

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

@@ -1,42 +1,39 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Admin
       module Clients
         # Search module for admin/search endpoints
         module Search
-
           # Get a list of queries
           #
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
           # @return [Hashie::Mash] List of queries
-          def search_query_text opts={}
-            get "admin/search/querytext"
+          def search_query_text(opts = {})
+            get 'admin/search/querytext', opts
           end
-          alias :query_text :search_query_text
 
           # Get a list of query names
           #
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
           # @return [Hashie::Mash] List of query names
-          def search_query_name opts={}
-            get "admin/search/queryname"
+          def search_query_name(opts = {})
+            get 'admin/search/queryname', opts
           end
-          alias :query_name :search_query_name
 
           # Get a list of rules
           #
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
           # @return [Hashie::Mash] List of rules
-          def search_rule_text opts={}
-            get "admin/search/ruletext"
+          def search_rule_text(opts = {})
+            get 'admin/search/ruletext', opts
           end
-          alias :rule_text :search_rule_text
-
         end
       end
     end
   end
-end
+end

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

@@ -1,10 +1,11 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Admin
       module Clients
         # Subclients module for admin/subclient endpoints
         module SubClients
-
           # Get all sub clients
           #
           # @param client_id [Integer] Id of the client
@@ -12,20 +13,18 @@ module BWAPI
           # @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
-          def client_sub_clients client_id, opts={}
+          def client_sub_clients(client_id, opts = {})
             get "admin/clients/#{client_id}/subclients", opts
           end
-          alias :sub_clients :client_sub_clients
 
           # Get specific sub client of client
           #
           # @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
-          def get_client_sub_client client_id, sub_client_id
+          def get_client_sub_client(client_id, sub_client_id)
             get "admin/clients/#{client_id}/subclients/#{sub_client_id}"
           end
-          alias :sub_client :get_client_sub_client
 
           # Create new subclient
           #
@@ -58,10 +57,9 @@ module BWAPI
           # @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
-          def create_client_sub_client client_id, opts={}
+          def create_client_sub_client(client_id, opts = {})
             post "admin/clients/#{client_id}/subclients", opts
           end
-          alias :create_sub_client :create_client_sub_client
 
           # Update new subclient
           #
@@ -95,23 +93,20 @@ module BWAPI
           # @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
-          def update_client_sub_client client_id, sub_client_id, opts={}
+          def update_client_sub_client(client_id, sub_client_id, opts = {})
             put "admin/clients/#{client_id}/subclients/#{sub_client_id}", opts
           end
-          alias :update_sub_client :update_client_sub_client
 
           # Delete specific sub client of client
           #
           # @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
-          def delete_client_sub_client client_id, sub_client_id
+          def delete_client_sub_client(client_id, sub_client_id)
             delete "admin/clients/#{client_id}/subclients/#{sub_client_id}"
           end
-          alias :delete_sub_client :delete_client_sub_client
-
         end
       end
     end
   end
-end
+end

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/client/admin/users/sharing'
 
 module BWAPI
@@ -6,7 +8,6 @@ module BWAPI
       module Clients
         # Users module for admin/users endpoints
         module Users
-
           # Get all users for client
           #
           # @param client_id [Integer] Id of the client
@@ -14,7 +15,7 @@ module BWAPI
           # @option opts [Integer] page Page of projects to retrieve
           # @option opts [Integer] pageSize Results per page of results
           # @return [Hashie::Mash] All client users
-          def client_users client_id, opts={}
+          def client_users(client_id, opts = {})
             get "admin/clients/#{client_id}/users", opts
           end
 
@@ -23,7 +24,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
-          def get_client_user client_id, user_id
+          def get_client_user(client_id, user_id)
             get "admin/clients/#{client_id}/users/#{user_id}"
           end
 
@@ -50,7 +51,7 @@ module BWAPI
           # @option opts [String] mobile The users mobile number
           # @option opts [Date] creationDate Date the user was created on
           # @return [Hashie::Mash] New user
-          def create_client_user client_id, opts={}
+          def create_client_user(client_id, opts = {})
             post "admin/clients/#{client_id}/users", opts
           end
 
@@ -78,14 +79,13 @@ module BWAPI
           # @option opts [String] mobile The users mobile number
           # @option opts [Date] creationDate Date the user was created on
           # @return [Hashie::Mash] New user
-          def update_client_user client_id, user_id, opts={}
+          def update_client_user(client_id, user_id, opts = {})
             put "admin/clients/#{client_id}/users/#{user_id}", opts
           end
 
           include BWAPI::Client::Admin::Clients::Users::Sharing
-
         end
       end
     end
   end
-end
+end