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

data/lib/bwapi/connection.rb

@@ -1,6 +1,7 @@
+# encoding: utf-8
+
 require 'faraday_middleware'
 require 'faraday/response/brandwatch_error'
-require 'faraday/utils/utils'
 
 module BWAPI
   # Connection module to handle requests
@@ -8,26 +9,16 @@ module BWAPI
     private
 
     # Create a connection to send request
-    def connection opts={}
-      connection = Faraday.new(opts) do |conn|
-
-        if opts[:force_urlencoded]
-          conn.request :url_encoded
-        else
-          conn.request :json
-        end
-
-        conn.request :json
-        conn.use Faraday::Response::BrandwatchError
-        conn.use FaradayMiddleware::FollowRedirects
-        conn.use FaradayMiddleware::Mashify
-        conn.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
-        conn.adapter adapter
+    def connection(opts = {})
+      connection = Faraday.new(opts) do |c|
+        c.use FaradayMiddleware::FollowRedirects
+        c.use BrandwatchError
+        c.use FaradayMiddleware::Mashify
+        c.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+        c.adapter adapter
       end
-
       connection.headers[:user_agent] = user_agent
       connection
     end
-
   end
-end
+end

data/lib/bwapi/error.rb

@@ -1,68 +1,75 @@
-module BWAPI
+# encoding: utf-8
 
+module BWAPI
   # BW error class to capture BWAPI error responses
   class BWError < StandardError
-    def initialize response = nil
-      errors_object = determine_errors(response)
-      super() if errors_object.nil?
-      super(generate_error_messages(errors_object))
+    def initialize(response = nil)
+      @errors = []
+      valid_response?(response)
+      @errors.empty? ? super() : super(@errors.join(', '))
     end
 
-    # Determines from response and returns error(s)
-    def determine_errors response
+    # Check if response is valid
+    #
+    # @param object [Object] response object to check for errors
+    def valid_response?(response)
       return nil if response.nil?
-      return nil unless response.is_a?(Hash) && response.has_key?(:body)
-      return nil unless response[:body].is_a?(Hash)
-
-      # Determine if response body has known error keys and return
-      if response[:body].has_key?('error') && response[:body].has_key?('error_description')
-        return response[:body]
-      elsif response[:body].has_key?('errors')
-        return response[:body]['errors']
+      return nil unless response.body.is_a?(Object) && response.respond_to?(:body)
+      return nil unless response.body.is_a?(Hashie::Mash)
+      body = errors_keys?(response.body)
+      parse_errors(body) unless body.nil?
+    end
+
+    # Check if response has known errors keys
+    #
+    # @param object [Object] response object to process for errors
+    def errors_keys?(body)
+      if body.error? && body.error_description?
+        body
+      elsif body.errors?
+        body.errors
       else
-        return nil
+        nil
       end
     end
 
-    # Generates error messsages based on error object passed
+    # Parses errors based on error body passed
     #
-    # @param errors_object [Hash] errors
-    def generate_error_messages errors_object
-      @error_messages = []
-      verify_object_class errors_object
-      return @error_messages.join(', ')
+    # @param body [Hash] errors
+    def parse_errors(body)
+      verify_type body
     end
 
-    # Verifies objects class
+    # Verifies type
     #
-    # @param object [Object] object to determine
-    def verify_object_class object
-      case object
+    # @param object [Object] type to determine
+    def verify_type(type)
+      case type
       when Array
-        split_array_errors(object)
+        split_array_errors type
       when Hash, Hashie::Mash
-        split_hash_errors(object)
+        split_hash_errors type
       when String
-        @error_messages << object
+        @errors << type
       end
     end
 
     # Iterates through errors in array
     #
     # @param array [Array] array to iterate
-    def split_array_errors array
-      array.each_with_index do |e, i|
-        verify_object_class array[i]
+    def split_array_errors(array)
+      array.each_with_index do |_e, i|
+        verify_type array[i]
       end
     end
 
     # Iterates through errors in hash
     #
     # @param hash [Hash] hash to iterate
-    def split_hash_errors hash
+    def split_hash_errors(hash)
       message = []
-      hash.each {|k,v| message << "%s: %s" % [k, v]}
-      @error_messages << message.flatten.join(' with ')
+      hash.each { |k, v| message << "#{k}: #{v}" }
+      @errors << message.flatten.join(' with ')
     end
   end
 
@@ -98,4 +105,4 @@ module BWAPI
 
   # Raised when Brandwatch returns a 503 HTTP status code
   class ServiceUnavailable < BWError; end
-end
+end

data/lib/bwapi/request.rb

@@ -1,15 +1,16 @@
+# encoding: utf-8
+
 require 'multi_json'
 
 module BWAPI
   # Request module to handle all requests to API
   module Request
-
     # Perform a get request
     #
     # @param path [String] URL path to send request
     # @param opts [Hash] Request parameters
     # @return [Hashie::Mash] Response body
-    def get path, opts={}
+    def get(path, opts = {})
       request(:get, path, opts).body
     end
 
@@ -18,7 +19,7 @@ module BWAPI
     # @param path [String] URL path to send request
     # @param opts [Hash] Request parameters
     # @return [Hashie::Mash] Response body
-    def delete path, opts={}
+    def delete(path, opts = {})
       request(:delete, path, opts).body
     end
 
@@ -27,7 +28,7 @@ module BWAPI
     # @param path [String] URL path to send request
     # @param opts [Hash] Request parameters
     # @return [Hashie::Mash] Response body
-    def post path, opts={}
+    def post(path, opts = {})
       request(:post, path, opts).body
     end
 
@@ -36,7 +37,7 @@ module BWAPI
     # @param path [String] URL path to send request
     # @param opts [Hash] Request parameters
     # @return [Hashie::Mash] Response body
-    def put path, opts={}
+    def put(path, opts = {})
       request(:put, path, opts).body
     end
 
@@ -45,25 +46,21 @@ module BWAPI
     # @param path [String] URL path to send request
     # @param opts [Hash] Request parameters
     # @return [Hashie::Mash] Response body
-    def patch path, opts={}
+    def patch(path, opts = {})
       request(:patch, path, opts).body
     end
 
     private
 
     # Sets connection options
-    #
-    # @param opts [Hash] hash of opts passed
-    # @return [Hash] connection options
-    def connection_options opts
+    def connection_options
       {
-        :headers => {
-          :authorization => access_token ? "bearer #{access_token}" : "",
-          :user_agent => user_agent
+        headers: {
+          authorization: access_token ? "bearer #{access_token}" : '',
+          user_agent: user_agent
         },
-        :force_urlencoded => opts.delete(:force_urlencoded) || false,
-        :url => api_endpoint,
-        :ssl => {:verify => verify_ssl}
+        url: api_endpoint,
+        ssl: { verify: verify_ssl }
       }
     end
 
@@ -73,16 +70,16 @@ module BWAPI
     # @param path [String] URL path to send request
     # @param opts [Hash] Request parameters
     # @return [Hashie::Mash] Response
-    def request method, path, opts={}
-      conn_options = connection_options opts
-      response = connection(conn_options).send(method) do |request|
+    def request(method, path, opts = {})
+      response = connection(connection_options).send(method) do |request|
         case method
         when :get
           request.url path, opts
         when :delete
           request.url path, opts
         when :patch, :post, :put
-          if conn_options[:force_urlencoded]
+          if opts.key? :force_urlencoded
+            opts.delete(:force_urlencoded)
             request.url path, opts
           else
             request.path = path
@@ -92,15 +89,15 @@ module BWAPI
       end
 
       if debug
-        log.info 'Connection options: %s' % conn_options
-        log.info 'Sending request type: %s' % method
-        log.info 'Request path: /%s' % path
-        log.info 'Request url: %s' % api_endpoint + '/' + path
-        log.info 'Request parameters: %s' % opts.to_json unless opts.nil?
-        log.info 'Response body: %s' % response.env[:body].to_json  unless response.env[:body].nil?
+        log.info "Connection options: #{conn_options}"
+        log.info "Sending request type: #{method}"
+        log.info "Request path: #{path}"
+        log.info "Request url: #{api_endpoint} / #{path}"
+        log.info "Request parameters: #{opts.to_json}" unless opts.nil?
+        log.info "Response body: #{response.env[:body].to_json}" unless response.env[:body].nil?
       end
 
       response
     end
   end
-end
+end

data/lib/bwapi/version.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+
+# BWAPI Version
 module BWAPI
-  VERSION = "6.5.0"
-end
+  VERSION = '7.0.0'
+end

data/lib/faraday/response/brandwatch_error.rb

@@ -1,27 +1,26 @@
+# encoding: utf-8
+
 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,
-      401 => BWAPI::Unauthorized,
-      403 => BWAPI::Forbidden,
-      404 => BWAPI::NotFound,
-      406 => BWAPI::NotAcceptable,
-      422 => BWAPI::UnprocessableEntity,
-      429 => BWAPI::TooManyRequests,
-      500 => BWAPI::InternalServerError,
-      501 => BWAPI::NotImplemented,
-      502 => BWAPI::BadGateway,
-      503 => BWAPI::ServiceUnavailable
-    }
-
-    def on_complete(response)
-      key = response[:status].to_i
-      raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
-    end
+# Brandwatch response middleware to handle errors
+class BrandwatchError < Faraday::Response::Middleware
+  ERROR_MAP = {
+    400 => BWAPI::BadRequest,
+    401 => BWAPI::Unauthorized,
+    403 => BWAPI::Forbidden,
+    404 => BWAPI::NotFound,
+    406 => BWAPI::NotAcceptable,
+    422 => BWAPI::UnprocessableEntity,
+    429 => BWAPI::TooManyRequests,
+    500 => BWAPI::InternalServerError,
+    501 => BWAPI::NotImplemented,
+    502 => BWAPI::BadGateway,
+    503 => BWAPI::ServiceUnavailable
+  }
 
+  def on_complete(response)
+    key = response[:status].to_i
+    fail ERROR_MAP[key].new(response) if ERROR_MAP.key? key
   end
-end
+end

data/spec/bwapi/authentication_spec.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
+
 require 'helper'
 
 describe BWAPI::Authentication do
-
   before do
     BWAPI.reset
   end
@@ -12,14 +13,14 @@ describe BWAPI::Authentication do
     end
 
     it 'returns false when not authenticated' do
-      bw = BWAPI::Client.new :access_token => 'abcdef-ghijkl-123456-789012'
+      bw = BWAPI::Client.new access_token: 'abcdef-ghijkl-123456-789012'
       expect(bw.authenticated?).to eql(true)
     end
   end
 
   describe '.application_client?' do
     it 'returns true when client is a brandwatch-application-client' do
-      bw = BWAPI::Client.new :client_id => 'brandwatch-application-client'
+      bw = BWAPI::Client.new client_id: 'brandwatch-application-client'
       expect(bw.application_client?).to eql(true)
     end
 
@@ -30,12 +31,12 @@ describe BWAPI::Authentication do
 
   describe '.api_client?' do
     it 'returns true when client is a brandwatch-api-client' do
-      bw = BWAPI::Client.new :client_id => 'brandwatch-api-client'
+      bw = BWAPI::Client.new client_id: 'brandwatch-api-client'
       expect(bw.api_client?).to eql(true)
     end
 
     it 'returns false when a client is not a brandwatch-api-client' do
-      bw = BWAPI::Client.new :client_id => 'brandwatch-application-client'
+      bw = BWAPI::Client.new client_id: 'brandwatch-application-client'
       expect(bw.api_client?).to eql(false)
     end
   end
@@ -47,11 +48,10 @@ describe BWAPI::Authentication do
     end
 
     it 'returns credentials when netrc is true' do
-      bw = BWAPI::Client.new :netrc => true, :netrc_file => File.join(fixture_path, '.netrc')
+      bw = BWAPI::Client.new netrc: true, netrc_file: File.join(fixture_path, '.netrc')
       bw.netrc_credentials
       expect(bw.username).to eql('testuser@brandwatch.com')
       expect(bw.password).to eql('password')
     end
-
   end
 end

data/spec/bwapi/client_spec.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
+
 require 'helper'
 
 describe BWAPI::Client do
-
   before do
     BWAPI.reset
   end
@@ -74,7 +75,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a default_adapter value' do
-          bw = BWAPI::Client.new :adapter => 'custom_adapter'
+          bw = BWAPI::Client.new adapter: 'custom_adapter'
           expect(bw.adapter).to eql('custom_adapter')
         end
       end
@@ -85,29 +86,29 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a user_agent value' do
-          bw = BWAPI::Client.new :user_agent => 'custom_user_agent'
+          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/")
+          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'
+          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")
+          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'
+          bw = BWAPI::Client.new client_id: 'custom_client_id'
           expect(bw.client_id).to eql('custom_client_id')
         end
       end
@@ -118,7 +119,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set true for the netrc value' do
-          bw = BWAPI::Client.new :netrc => true, :netrc_file => File.join(fixture_path, '.netrc')
+          bw = BWAPI::Client.new netrc: true, netrc_file: File.join(fixture_path, '.netrc')
           expect(bw.netrc).to eql(true)
         end
       end
@@ -129,7 +130,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a netrc_file value' do
-          bw = BWAPI::Client.new :netrc_file => 'example/.netrc'
+          bw = BWAPI::Client.new netrc_file: 'example/.netrc'
           expect(bw.netrc_file).to eql('example/.netrc')
         end
       end
@@ -140,7 +141,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a username value' do
-          bw = BWAPI::Client.new :username => 'jonathan@brandwatch.com'
+          bw = BWAPI::Client.new username: 'jonathan@brandwatch.com'
           expect(bw.username).to eql('jonathan@brandwatch.com')
         end
       end
@@ -151,7 +152,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a password value' do
-          bw = BWAPI::Client.new :password => 'pa55w0rd'
+          bw = BWAPI::Client.new password: 'pa55w0rd'
           expect(bw.password).to eql('pa55w0rd')
         end
       end
@@ -162,7 +163,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a grant_type value' do
-          bw = BWAPI::Client.new :grant_type => 'custom_grant_type'
+          bw = BWAPI::Client.new grant_type: 'custom_grant_type'
           expect(bw.grant_type).to eql('custom_grant_type')
         end
       end
@@ -173,7 +174,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a access_token value' do
-          bw = BWAPI::Client.new :access_token => 'abcdef-ghijkl-123456-789012'
+          bw = BWAPI::Client.new access_token: 'abcdef-ghijkl-123456-789012'
           expect(bw.access_token).to eql('abcdef-ghijkl-123456-789012')
         end
       end
@@ -184,7 +185,7 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a refresh_token value' do
-          bw = BWAPI::Client.new :refresh_token => 'abcdef-ghijkl-123456-789012'
+          bw = BWAPI::Client.new refresh_token: 'abcdef-ghijkl-123456-789012'
           expect(bw.refresh_token).to eql('abcdef-ghijkl-123456-789012')
         end
       end
@@ -195,11 +196,10 @@ describe BWAPI::Client do
         end
 
         it 'should allow a user to set a client_secret value' do
-          bw = BWAPI::Client.new :client_secret => 'custom_client_secret'
+          bw = BWAPI::Client.new client_secret: 'custom_client_secret'
           expect(bw.client_secret).to eql('custom_client_secret')
         end
       end
     end
-
   end
-end
+end