bwapi 1.0.0

data/lib/bwapi/client/test_search.rb

@@ -0,0 +1,14 @@
+module BWAPI
+  class Client
+    module TestSearch
+
+      # TODO: Uncomment once the endpoint has been fixed
+      # Retrieve full text for a given url
+      #def test_search_content opts
+      #  get "testsearch/content", opts
+      #end
+      #alias :test_search :test_search_content
+
+    end
+  end
+end

data/lib/bwapi/client/user.rb

@@ -0,0 +1,58 @@
+require 'bwapi/client/user/notifications'
+
+module BWAPI
+  class Client
+    module User
+
+      # Get the current user
+      #
+      # @return [Hashie::Mash] User information
+      def user
+        get "user"
+      end
+
+      # Update the current user
+      #
+      # @param opts [Hash] options Hash of parameters
+      # @option opts [Integer] id Id of the user
+      # @option opts [Hash] tags The users assigned tags
+      # @option opts [String] passwordConfirmation The confirmed password
+      # @option opts [Boolean] enabled The status of the user
+      # @option opts [String] lastName The last name of the user
+      # @option opts [String] phone The users phone number
+      # @option opts [String] department The users department
+      # @option opts [String] job The users job
+      # @option opts [String] messenger The users IM details
+      # @option opts [String] password The password of the user
+      # @option opts [Integer] clientId The users client id
+      # @option opts [String] username The users username
+      # @option opts [String] address The users address
+      # @option opts [String] uiRole The users ui role
+      # @option opts [Array] apiRole The users api role
+      # @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] Updated user information
+      def update_user opts
+        put "user", opts
+      end
+
+      # Get users api role
+      #
+      # @return [String] Users api role
+      def api_role
+        user.apiRole
+      end
+
+      # Get users ui role
+      #
+      # @return [String] Users ui role
+      def ui_role
+        user.uiRole
+      end
+
+      include BWAPI::Client::User::Notifications
+
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module BWAPI
+  class Client
+    module User
+      module Notifications
+
+        # Get the current user notifications
+        #
+        # @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] User notifications
+        def notifications opts={}
+          get "user/notifications", opts
+        end
+
+        # Update users existing notifications
+        #
+        # @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
+          put "user/notifications", opts
+        end
+
+        # Delete a users existing notification
+        #
+        # @param notification_id [Integer] Id of notification
+        # @return [Hashie::Mash] Deleted user notifications
+        def delete_notification notification_id
+          delete "user/notifications/#{notification_id}"
+        end
+
+      end
+    end
+  end
+end

data/lib/bwapi/configuration.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+
+module BWAPI
+  module Configuration
+
+    OPTION_KEYS = [
+      :api_endpoint,
+      :user_agent,
+      :adapter,
+      :username,
+      :password,
+      :grant_type,
+      :access_token,
+      :refresh_token,
+      :expires_in,
+      :client_id,
+      :client_secret,
+      :netrc,
+      :netrc_file
+    ].freeze
+
+    DEFAULT_ADAPTER       = Faraday.default_adapter
+    DEFAULT_API_ENDPOINT  = ENV['BWAPI_API_ENDPOINT'] || 'http://newapi.brandwatch.com/'
+    DEFAULT_CLIENT_ID     = 'brandwatch-api-client'
+    DEFAULT_USER_AGENT    = "BWAPI Ruby Gem #{BWAPI::VERSION}".freeze
+    DEFAULT_NETRC_FILE    = File.join(ENV['HOME'], '.netrc')
+
+    attr_accessor *OPTION_KEYS
+
+    # Extend hook
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    # Convert option_keys to hash and return
+    def options
+      OPTION_KEYS.inject({}){|o,k|o.merge!(k => send(k))}
+    end
+
+    def reset
+      self.adapter             = DEFAULT_ADAPTER
+      self.user_agent          = DEFAULT_USER_AGENT
+      self.api_endpoint        = DEFAULT_API_ENDPOINT
+      self.username            = nil
+      self.password            = nil
+      self.grant_type          = nil
+      self.access_token        = nil
+      self.refresh_token       = nil
+      self.client_id           = DEFAULT_CLIENT_ID
+      self.client_secret       = nil
+      self.netrc               = false
+      self.netrc_file          = DEFAULT_NETRC_FILE
+    end
+  end
+end

data/lib/bwapi/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+require 'faraday/response/brandwatch_error'
+require 'faraday/utils/utils'
+
+module BWAPI
+  module Connection
+    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
+      end
+
+      connection.headers[:user_agent] = user_agent
+
+      connection
+    end
+
+  end
+end

data/lib/bwapi/error.rb

@@ -0,0 +1,42 @@
+module BWAPI
+
+  # BW error class to capture BWAPI error responses
+  class BWError < StandardError
+    def initialize(response=nil)
+      super()
+    end
+  end
+
+  # Raised when Brandwatch returns a 400 HTTP status code
+  class BadRequest < BWError; end
+
+  # Raised when Brandwatch returns a 401 HTTP status code
+  class Unauthorized < BWError; end
+
+  # Raised when Brandwatch returns a 403 HTTP status code
+  class Forbidden < BWError; end
+
+  # Raised when Brandwatch returns a 404 HTTP status code
+  class NotFound < BWError; end
+
+  # Raised when Brandwatch returns a 406 HTTP status code
+  class NotAcceptable < BWError; end
+
+  # Raised when Brandwatch returns a 422 HTTP status code
+  class UnprocessableEntity < BWError; end
+
+   # Raised when Brandwatch returns a 429 HTTP status code
+  class TooManyRequests < BWError; end
+
+  # Raised when Brandwatch returns a 500 HTTP status code
+  class InternalServerError < BWError; end
+
+  # Raised when Brandwatch returns a 501 HTTP status code
+  class NotImplemented < BWError; end
+
+  # Raised when Brandwatch returns a 502 HTTP status code
+  class BadGateway < BWError; end
+
+  # Raised when Brandwatch returns a 503 HTTP status code
+  class ServiceUnavailable < BWError; end
+end

data/lib/bwapi/request.rb

@@ -0,0 +1,93 @@
+require 'multi_json'
+
+module BWAPI
+  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={}
+      request(:get, path, opts).body
+    end
+
+    # Perform a delete request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def delete path, opts={}
+      request(:delete, path, opts).body
+    end
+
+    # Perform a post request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def post path, opts={}
+      request(:post, path, opts).body
+    end
+
+    # Perform a put request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def put path, opts={}
+      request(:put, path, opts).body
+    end
+
+    # Perform a patch request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def patch path, opts={}
+      request(:patch, path, opts).body
+    end
+
+    private
+
+    # Perform a request
+    #
+    # @param method [String] Type of request path
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response
+    def request method, path, opts={}
+      token = access_token
+
+      force_urlencoded  = opts.delete(:force_urlencoded) || false
+
+      conn_opts = {
+        :force_urlencoded => force_urlencoded,
+        :url => api_endpoint
+      }
+
+      response = connection(conn_opts).send(method) do |request|
+        # Add token to the header
+        if token
+          request.headers[:authorization] = "bearer #{token}"
+        end
+
+        case method
+        when :get
+          request.url path, opts
+        when :delete
+          request.url path, opts
+        when :patch, :post, :put
+          if force_urlencoded
+            request.url path, opts
+          else
+            request.path = path
+            request.body = MultiJson.dump(opts) unless opts.empty?
+          end
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/bwapi/version.rb

@@ -0,0 +1,3 @@
+module BWAPI
+  VERSION = "1.0.0"
+end

data/lib/faraday/response/brandwatch_error.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+require 'multi_json'
+
+module Faraday
+  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
+  end
+end

data/lib/faraday/utils/utils.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+
+# TODO: Remove this patch once latest faraday rc has been released
+# https://github.com/lostisland/faraday/issues/182#issuecomment-19518167
+module Faraday
+  module Utils
+    def build_nested_query(value, prefix = nil)
+      case value
+      when Array
+        value.map { |v| build_nested_query(v, "#{prefix}") }.join("&")
+        #value.map { |v| build_nested_query(v, "#{prefix}%5B%5D") }.join("&")
+      when Hash
+        value.map { |k, v|
+          build_nested_query(v, prefix ? "#{prefix}#{escape(k)}" : escape(k))
+          #build_nested_query(v, prefix ? "#{prefix}%5B#{escape(k)}%5D" : escape(k))
+        }.join("&")
+      when NilClass
+        prefix
+      else
+        raise ArgumentError, "value must be a Hash" if prefix.nil?
+        "#{prefix}=#{escape(value)}"
+      end
+    end
+  end
+end

data/spec/bwapi/authentication_spec.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+describe BWAPI::Authentication do
+
+  before do
+    BWAPI.reset
+  end
+
+  describe '.authenticated?' do
+    it 'returns true when authenticated' do
+      expect(BWAPI::Client.new.authenticated?).to eql(false)
+    end
+
+    it 'returns false when not authenticated' do
+      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'
+      expect(bw.application_client?).to eql(true)
+    end
+
+    it 'returns false when a client is not a brandwatch-application-client' do
+      expect(BWAPI::Client.new.application_client?).to eql(false)
+    end
+  end
+
+  describe '.api_client?' do
+    it 'returns true when client is a brandwatch-api-client' do
+      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'
+      expect(bw.api_client?).to eql(false)
+    end
+  end
+
+  describe '.netrc_credentials' do
+    it 'returns nil when netrc is false' do
+      bw = BWAPI::Client.new
+      expect(bw.netrc_credentials).to eql(nil)
+    end
+
+    it 'returns credentials when netrc is true' do
+      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