bwapi 2.0.3 → 3.0.0.pre.88

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 65abb780f56fe5425751d96bcbe9ddbeebdf1f2f
-  data.tar.gz: e0a39fbc3d4ec72672c6bf64b834ad6075b3443d
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTIxOTlhYmM3ZGYxNTk4NGZjMDk5NWE0M2NkODlhZTA3N2U5NDgwYQ==
+  data.tar.gz: !binary |-
+    ZDk0N2NhMGNkYmIwNTJjNzQxOWFmMzE5NjJhZjdlYjIxMjFjNjk1Zg==
 SHA512:
-  metadata.gz: b18b820171841552772b9f684bc1963fdefc06c1e12bfe998b46b278cf1a59c0fa1e3417470bf176d41270ce00dc55c9b6c449b064be2b7b0bef28e7927b8804
-  data.tar.gz: 7dfe0918011da80c34275f68539521df90bdfb23cfb7387d3ea6f4bba5d3bb8575f7bb4f54d67663e480be886ec62b0a8775dba809fed8ef8fa0209980f6c554
+  metadata.gz: !binary |-
+    YWI4NDJiNmQ3NGZhZDZhMGNhZTNhMDlkMzcxMGZmOTRmOTVhMzY3NjU2ZmQ1
+    NmY2OWQ1Nzk2MGNjNjMwOTM4YzI1M2I2ZjI4MTVkZWE1MDNkMTk5MTMxNjM1
+    ODE0NmI1ZDZiODI0M2JmNzM3ODlkY2MyNWQ0YTQxYzcyMGEzZmE=
+  data.tar.gz: !binary |-
+    NDM4ZGQ1ZDYzZTQzMjhlMzk1YjIzMzJlZmZlMDc2NmUyNmQxNzNjY2VkMWMw
+    NjEzOWQzYjA4ZjFjOWJlZGRhNjZmZmI3OWUyMzM4MDNkZDA3NjY2YTIzODBm
+    Y2YyYThiYjVlNjEyZGRmZjAxOTM1ZTk2NjgzZGRmNDExMWU1ODY=

data/bwapi.gemspec

@@ -4,9 +4,9 @@ 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        = '2013-11-21'
-  s.summary     = 'Brandwatch v2 API Wrapper'
-  s.description = 'A Ruby wrapper for the Brandwatch v2 API'
+  s.date        = '2013-11-30'
+  s.summary     = 'Brandwatch API Wrapper'
+  s.description = 'A Ruby wrapper for the Brandwatch API'
   s.author      = 'Jonathan Chrisp'
   s.email       = 'jonathan@brandwatch.com'
   s.license     = 'MIT'

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

@@ -10,7 +10,7 @@ module BWAPI
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
           # @return [Hashie::Mash] List of queries
-          def search_query_text opts
+          def search_query_text opts={}
             get "admin/search/querytext"
           end
           alias :query_text :search_query_text
@@ -20,7 +20,7 @@ module BWAPI
           # @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
+          def search_query_name opts={}
             get "admin/search/queryname"
           end
           alias :query_name :search_query_name
@@ -30,7 +30,7 @@ module BWAPI
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] text Text expression
           # @return [Hashie::Mash] List of rules
-          def search_rule_text opts
+          def search_rule_text opts={}
             get "admin/search/ruletext"
           end
           alias :rule_text :search_rule_text

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

@@ -12,8 +12,8 @@ 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
-            get "admin/clients/#{client_id}/subclients"
+          def client_sub_clients client_id, opts={}
+            get "admin/clients/#{client_id}/subclients", opts
           end
           alias :sub_clients :client_sub_clients
 
@@ -58,7 +58,7 @@ 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
@@ -95,7 +95,7 @@ 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

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

@@ -50,7 +50,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,7 +78,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 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
 

data/lib/bwapi/client/brandwatch.rb

@@ -21,7 +21,7 @@ module BWAPI
       # @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
-      def brandwatch_data_download project_id, opts
+      def brandwatch_data_download project_id, opts={}
         post "brandwatch/#{project_id}/datadownload", opts
       end
 

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

@@ -17,7 +17,7 @@ module BWAPI
         # @param opts [Hash] options Hash of parameters
         # @option opts [Array] ClientModules Client Modules to edit
         # @return [Hashie::Mash] Update client modules
-        def update_brandwatch_client_module opts
+        def update_brandwatch_client_module opts={}
           put "brandwatch/clientModules", opts
         end
 

data/lib/bwapi/client/oauth.rb

@@ -16,7 +16,7 @@ module BWAPI
         opts = {
           username: username,
           password: password,
-          grant_type: grant_type ? grant_type : 'password',
+          grant_type: determine_grant_type,
           client_secret: client_secret,
           client_id: client_id,
           force_urlencoded: true
@@ -39,7 +39,6 @@ module BWAPI
         opts = {
           username: username,
           password: password,
-
           refresh_token: refresh_token,
           grant_type: 'refresh_token',
           client_id: client_id,
@@ -50,24 +49,23 @@ module BWAPI
       end
       alias :refresh :oauth_refresh_token
 
+      # Determines grant-type used for client
+      #
+      # @return [String] relevant grant type for client
+      def determine_grant_type
+        return grant_type unless grant_type.nil?
+        api_client? ? 'api-password' : 'password'
+      end
+
       # Sends a oauth request
       #
       # @param opts [Hash] options hash of parameters
-      def oauth_request opts
-        begin
-          creds = post 'oauth/token', opts
-        rescue BWAPI::BWError
-          false
-        else
-          self.access_token = creds.access_token
-          self.expires_in = creds.expires_in
-
-          if application_client?
-            self.refresh_token = creds.refresh_token
-          end
-
-          true
-        end
+      def oauth_request opts={}
+        creds = post 'oauth/token', opts
+        self.access_token  = creds.access_token
+        self.expires_in    = creds.expires_in
+        self.refresh_token = creds.refresh_token if application_client?
+        creds
       end
 
     end

data/lib/bwapi/client/projects.rb

@@ -47,7 +47,7 @@ module BWAPI
       # @option opts [Date] creationDate Date the project was created on
       # @option opts [Integer] creationUserId User ID of the user who created the project
       # @return [Hashie::Mash] New project
-      def create_project opts
+      def create_project opts={}
         post "projects", opts
       end
 
@@ -64,7 +64,7 @@ module BWAPI
       # @option opts [Date] creationDate Date the project was created on
       # @option opts [Integer] creationUserId User ID of the user who created the project
       # @return [Hashie::Mash] Updated project
-      def update_project project_id, opts
+      def update_project project_id, opts={}
         put "projects/#{project_id}", opts
       end
 

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

@@ -25,7 +25,7 @@ module BWAPI
         # @option opts [Hash] filter The filters to apply
         # @option opts [Array] dateRanges Date range ids
         # @return [Hashie::Mash] All Chart data mentions
-        def data_date_ranges_days project_id, opts
+        def data_date_ranges_days project_id, opts={}
           get "projects/#{project_id}/data/volume/dataRanges/days", opts
         end
 

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

@@ -43,7 +43,7 @@ module BWAPI
           # @option opts [Integer] queryId Query id of backfill
           # @option opts [String] statusMessages Current status message of backfill
           # @return [Hashie::Mash] New backfill for query
-          def create_backfill project_id, query_id, opts
+          def create_backfill project_id, query_id, opts={}
             post "projects/#{project_id}/queries/#{query_id}/backfill", opts
           end
 

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

@@ -33,7 +33,7 @@ module BWAPI
           # @option opts [Integer] queryId Id of the query
           # @option opts [Array] StoredDateRangeDTO Date ranges to be stored
           # @return [Hashie::Mash] New date range
-          def create_date_range project_id, query_id, opts
+          def create_date_range project_id, query_id, opts={}
             post "projects/#{project_id}/#{query_id}/date-range", opts
           end
 
@@ -47,7 +47,7 @@ module BWAPI
           # @option opts [Integer] dateRangeId Id of the date range
           # @option opts [Array] StoredDateRangeDTO Date ranges to be edited
           # @return [Hashie::Mash] Update date range
-          def update_date_range project_id, query_id, opts
+          def update_date_range project_id, query_id, opts={}
             put "projects/#{project_id}/#{query_id}/date-range/#{date_range_id}", opts
           end
 

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

@@ -28,7 +28,7 @@ module BWAPI
           # @option opts [Integer] id Id of the mention
           # @option opts [Hash] MentionPatchDTO patch to be applied
           # @return [Hashie::Mash] Updated query mention
-          def update_query_mention project_id, query_id, mention_id, opts
+          def update_query_mention project_id, query_id, mention_id, opts={}
             patch "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}", opts
           end
 
@@ -43,7 +43,7 @@ module BWAPI
           # @option opts [Integer] id Id of the mention
           # @option opts [Hash] Map patch to be applied
           # @return [Hashie::Mash] Deleted query mention
-          def delete_query_mention project_id, query_id, mention_id, opts
+          def delete_query_mention project_id, query_id, mention_id, opts={}
             delete "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}", opts
           end
 

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

@@ -15,7 +15,7 @@ module BWAPI
         # @option opts [String] type Type of signal
         # @option opts [Hash] filter The filter(s) to apply
         # @return [Hashie::Mash] All signals for user in project
-        def signals project_id, opts
+        def signals project_id, opts={}
           get "projects/#{project_id}/signals", opts
         end
 
@@ -28,7 +28,7 @@ module BWAPI
         # @option opts [String] comment User comment
         # @option opts [Integer] signalId Id of signal
         # @return [Hashie::Mash] Update signal for given user
-        def set_signal_vote project_id, opts
+        def set_signal_vote project_id, opts={}
           post "projects/#{project_id}/signals/vote", opts
         end
 

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

@@ -31,7 +31,7 @@ module BWAPI
         # @option opts [Integer] id Id of the tag
         # @option opts [String] name Name of the tag
         # @return [Hashie::Mash] New tag
-        def create_tag project_id, opts
+        def create_tag project_id, opts={}
           post "projects/#{project_id}/tags", opts
         end
 
@@ -43,7 +43,7 @@ module BWAPI
         # @option opts [Integer] id Id of the tag
         # @option opts [String] name Name of the tag
         # @return [Hashie::Mash] Updated tag
-        def update_tag project_id, tag_id, opts
+        def update_tag project_id, tag_id, opts={}
           put "projects/#{project_id}/tags/#{tag_id}", opts
         end
 

data/lib/bwapi/client/query_validation.rb

@@ -9,7 +9,7 @@ module BWAPI
       # @option opts [String] query Query string
       # @option opts [Array] language Languages for query string
       # @return [Hashie::Mash] Query string validation results
-      def query_validation opts
+      def query_validation opts={}
         get "query-validation", opts
       end
 
@@ -19,7 +19,7 @@ module BWAPI
       # @option opts [String] query Query string
       # @option opts [Array] language Languages for query string
       # @return [Hashie::Mash] Query string validation results
-      def search_within opts
+      def search_within opts={}
         get "query-validation/searchwithin", opts
       end
 

data/lib/bwapi/client/user.rb

@@ -34,7 +34,7 @@ module BWAPI
       # @option opts [String] mobile The users mobile number
       # @option opts [Date] creationDate Date the user was created on
       # @return [Hashie::Mash] Updated user information
-      def update_user opts
+      def update_user opts={}
         put "user", opts
       end
 

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

@@ -19,7 +19,7 @@ module BWAPI
         # @param opts [Hash] options Hash of parameters
         # @option opts [Array] list User notifications to be edited
         # @return [Hashie::Mash] Updated user notifications
-        def update_notification opts
+        def update_notification opts={}
           put "user/notifications", opts
         end
 

data/lib/bwapi/error.rb

@@ -2,16 +2,67 @@ module BWAPI
 
   # BW error class to capture BWAPI error responses
   class BWError < StandardError
-    def initialize response=nil
-      if response.is_a? Hash
-        errors = []
-        response[:body]["errors"].each do |error|
-          errors.push error['message']
-        end
-        response = errors.join(', ')
+    def initialize response = nil
+      errors_object = determine_errors(response)
+      super() if errors_object.nil?
+      super(generate_error_messages(errors_object))
+    end
+
+    # Determines from response and returns error(s)
+    def determine_errors 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']
+      else
+        return nil
+      end
+    end
+
+    # Generates error messsages based on error object passed
+    #
+    # @param errors_object [Hash] errors
+    def generate_error_messages errors_object
+      @error_messages = []
+      verify_object_class errors_object
+      return @error_messages.join(', ')
+    end
+
+    # Verifies objects class
+    #
+    # @param object [Object] object to determine
+    def verify_object_class object
+      case object
+      when Array
+        split_array_errors(object)
+      when Hash, Hashie::Mash
+        split_hash_errors(object)
+      when String
+        @error_messages << object
       end
+    end
 
-      super(response)
+    # 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]
+      end
+    end
+
+    # Iterates through errors in hash
+    #
+    # @param hash [Hash] hash to iterate
+    def split_hash_errors hash
+      message = []
+      hash.each {|k,v| message << "%s: %s" % [k, v]}
+      @error_messages << message.flatten.join(' with ')
     end
   end
 
@@ -19,11 +70,7 @@ module BWAPI
   class BadRequest < BWError; end
 
   # Raised when Brandwatch returns a 401 HTTP status code
-  class Unauthorized < BWError
-    def initialize response=nil
-      response.nil? ? super() : super("#{response[:body]['error_description'] }")
-    end
-  end
+  class Unauthorized < BWError; end
 
   # Raised when Brandwatch returns a 403 HTTP status code
   class Forbidden < BWError; end

data/lib/bwapi/version.rb

@@ -1,3 +1,3 @@
 module BWAPI
-  VERSION = "2.0.3"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0.pre.88
 platform: ruby
 authors:
 - Jonathan Chrisp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,7 +94,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.5
-description: A Ruby wrapper for the Brandwatch v2 API
+description: A Ruby wrapper for the Brandwatch API
 email: jonathan@brandwatch.com
 executables:
 - bwapi
@@ -172,24 +172,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.1.10
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Brandwatch v2 API Wrapper
+summary: Brandwatch API Wrapper
 test_files:
 - spec/bwapi/authentication_spec.rb
 - spec/bwapi/client_spec.rb
 - spec/bwapi_spec.rb
 - spec/fixtures/.netrc
 - spec/helper.rb
-has_rdoc: