bwapi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d950eb3141a3d094f3a8acda0bcc07fbaca916ca
+  data.tar.gz: 9461dd2860680d76e8cac1ebe9ad287095ca309b
+SHA512:
+  metadata.gz: 5f97eff77c439a33cb972012cce89bacccfbda6540f5022542e300e00e49f6e9741bb1c764acba767dee34f6773ff8314311fd02e1e84c19ee862983fe2888fa
+  data.tar.gz: fde6d236a3b0b43ea7dce59f91f2032dd83388dc5fb1aa77201aa292f60bd2c71592b0dfe21e5c4bf9f6090da406152ccdd34333531cc5d7db9e4a408cfe8f2a

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+report.html
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+
+before_script:
+  - chmod 600 spec/fixtures/.netrc
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'bundler', '~> 1.3.5'
+gem "coveralls", "~> 0.6.7", require: false
+
+gemspec

data/LICENCE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jonathan Chrisp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,15 @@
+# bwapi
+
+__PLEASE NOTE THAT THIS PROJECT IS NOT OFFICIALLY SUPPORTED BY BRANDWATCH__
+
+A Ruby interface to the Brandwatch v2 API. The projects design is modelled on the GitHub Octokit wrapper which can be found here: https://github.com/octokit/octokit.rb.
+
+## Tests
+There are a number of unit tests which are included as part of this project which are run by rspec. Please run:
+
+      rspec spec
+      
+Please note that a number of tests still need to be added so I don't currently have complete coverage.
+
+## Feedback
+I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com

data/bin/bwapi

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'bwapi'

data/bwapi.gemspec

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + "/lib/bwapi/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'bwapi'
+  s.version     = BWAPI::VERSION
+  s.date        = '2013-07-24'
+  s.summary     = 'Brandwatch v2 API Wrapper'
+  s.description = 'A Ruby wrapper for the Brandwatch v2 API'
+  s.author      = 'Jonathan Chrisp'
+  s.email       = 'jonathan@brandwatch.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/jonathanchrisp/bwapi'
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+  s.add_development_dependency 'pry', '~> 0.9.12.2'
+
+  s.add_runtime_dependency 'faraday', '~> 0.8.7'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.9.0'
+  s.add_runtime_dependency 'netrc', '~> 0.7.7'
+
+  s.files         = `git ls-files`.split("\n")
+  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

data/lib/bwapi.rb

@@ -0,0 +1,28 @@
+require 'bwapi/version'
+require 'bwapi/configuration'
+require 'bwapi/error'
+require 'bwapi/client'
+
+module BWAPI
+  extend Configuration
+  class << self
+
+    # Alias for BWAPI::Client.new
+    #
+    # @return [BWAPI::Client]
+    def new opts={}
+      BWAPI::Client.new opts
+    end
+
+    # Delegate to BWAPI::Client.new
+    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
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end
+end

data/lib/bwapi/authentication.rb

@@ -0,0 +1,42 @@
+require 'netrc'
+
+module BWAPI
+  module Authentication
+
+    # Check if user is authenicated
+    #
+    # @return [Boolean] Authenticated status
+    def authenticated?
+      !!access_token
+    end
+
+    # Check if user is a brandwatch-application-client type
+    #
+    # @return [Boolean] Application client status
+    def application_client?
+      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?
+      client_id == 'brandwatch-api-client' ? true : false
+    end
+
+    # Set username and password via netrc
+    #
+    # @param netrc [Boolean] Netrc status
+    def netrc_credentials netrc=false
+      return unless netrc
+      file = Netrc.read netrc_file
+
+      # Get credentials using host
+      netrc_host = URI.parse(api_endpoint).host
+      creds = file[netrc_host]
+      self.username = creds.shift
+      self.password = creds.shift
+    end
+
+  end
+end

data/lib/bwapi/client.rb

@@ -0,0 +1,54 @@
+require 'bwapi/authentication'
+require 'bwapi/connection'
+require 'bwapi/request'
+
+require 'bwapi/client/admin'
+require 'bwapi/client/brandwatch'
+require 'bwapi/client/client'
+require 'bwapi/client/error_codes'
+require 'bwapi/client/logout'
+require 'bwapi/client/me'
+require 'bwapi/client/oauth'
+require 'bwapi/client/ping'
+require 'bwapi/client/sso'
+require 'bwapi/client/projects'
+require 'bwapi/client/query_validation'
+require 'bwapi/client/test_search'
+require 'bwapi/client/user'
+
+module BWAPI
+  class Client
+
+    attr_accessor *Configuration::OPTION_KEYS
+
+    def initialize opts={}
+      # Merge opts
+      opts = BWAPI.options.merge opts
+
+      # Create instance variables
+      Configuration::OPTION_KEYS.each do |k|
+        send "#{k}=", opts[k]
+      end
+
+      netrc_credentials opts[:netrc]
+    end
+
+    include BWAPI::Authentication
+    include BWAPI::Connection
+    include BWAPI::Request
+
+    include BWAPI::Client::Admin
+    include BWAPI::Client::Brandwatch
+    include BWAPI::Client::Client
+    include BWAPI::Client::ErrorCodes
+    include BWAPI::Client::Logout
+    include BWAPI::Client::Me
+    include BWAPI::Client::OAuth
+    include BWAPI::Client::Ping
+    include BWAPI::Client::Projects
+    include BWAPI::Client::SSO
+    include BWAPI::Client::QueryValidation
+    include BWAPI::Client::TestSearch
+    include BWAPI::Client::User
+  end
+end

data/lib/bwapi/client/admin.rb

@@ -0,0 +1,35 @@
+require 'bwapi/client/admin/become'
+require 'bwapi/client/admin/search'
+require 'bwapi/client/admin/sub_clients'
+require 'bwapi/client/admin/users'
+
+module BWAPI
+  class Client
+    module Admin
+
+      # Get the active queries irrespective of project
+      #
+      # @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
+      # @option opts [Integer] sortBy Filter to sort queries by
+      # @return [Hashie::Mash] All active queries
+      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"
+      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

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

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module Admin
+      module Clients
+        module Become
+
+          # Become user
+          #
+          # @note must be a client admin user
+          #
+          # @param id [Integer] The user id
+          # @return [Hashie::Mash] User credentials
+          def admin_become id
+            get "admin/become/#{id}"
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module BWAPI
+  class Client
+    module Admin
+      module Clients
+        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"
+          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"
+          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"
+          end
+          alias :rule_text :search_rule_text
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+module BWAPI
+  class Client
+    module Admin
+      module Clients
+        module SubClients
+
+          # Get all sub clients
+          #
+          # @param id [Integer] Id of the client
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] id Id of the client
+          # @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 id
+            get "admin/clients/#{id}/subclient"
+          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 clients for client
+          def get_client_sub_client client_id, sub_client_id
+            get "admin/clients/#{client_id}/subclient/#{sub_client_id}"
+          end
+          alias :sub_client :get_client_sub_client
+
+          # Create new subclient
+          #
+          # @param id [Integer] Id of the client
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] clientId Current client id
+          # @option opts [Date] startDate Start date of the client
+          # @option opts [String] contactTitle Contact title of the client
+          # @option opts [String] address1 Address line one of the client
+          # @option opts [String] address2 Address line two of the client
+          # @option opts [String] address3 Address line three of the client
+          # @option opts [String] pricingModel Pricing model of the client
+          # @option opts [Integer] mentionArchiveSize Mention archive size for the client
+          # @option opts [Integer] id Id of the sub client
+          # @option opts [Integer] parentId Parent id of the sub client
+          # @option opts [Integer] maxUsers Maxiumum number of users for the client
+          # @option opts [Boolean] isLegacy Legacy status of the client
+          # @option opts [String] name Name of the client
+          # @option opts [String] contactTelephone Telephone number of the client
+          # @option opts [Integer] priceStructureId Id of the price structure for client
+          # @option opts [Hash] tags Tags for the client
+          # @option opts [String] website The website for the client
+          # @option opts [String] contactEmail The contact email for the client
+          # @option opts [Date] expiryDate The expiry date for the client
+          # @option opts [String] theme The theme of the client
+          # @option opts [Integer] priceStructureLineId The level of the price structure for the client
+          # @option opts [Integer] mentionBasedPricingMatrixLevel The amount of mentions allowed
+          # @option opts [String] postcode The postcode of the client
+          # @option opts [String] country The country of the client
+          # @option opts [String] contactName The contact name of the client
+          # @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 id, opts
+            post "admin/clients/#{id}/subclient", opts
+          end
+          alias :create_sub_client :create_client_sub_client
+
+          # Update new subclient
+          #
+          # @param client_id [Integer] Id of the client
+          # @param sub_client_id [Integer] Id of the sub client
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] clientId Current client id
+          # @option opts [Date] startDate Start date of the client
+          # @option opts [String] contactTitle Contact title of the client
+          # @option opts [String] address1 Address line one of the client
+          # @option opts [String] address2 Address line two of the client
+          # @option opts [String] address3 Address line three of the client
+          # @option opts [String] pricingModel Pricing model of the client
+          # @option opts [Integer] mentionArchiveSize Mention archive size for the client
+          # @option opts [Integer] id Id of the sub client
+          # @option opts [Integer] parentId Parent id of the sub client
+          # @option opts [Integer] maxUsers Maxiumum number of users for the client
+          # @option opts [Boolean] isLegacy Legacy status of the client
+          # @option opts [String] name Name of the client
+          # @option opts [String] contactTelephone Telephone number of the client
+          # @option opts [Integer] priceStructureId Id of the price structure for client
+          # @option opts [Hash] tags Tags for the client
+          # @option opts [String] website The website for the client
+          # @option opts [String] contactEmail The contact email for the client
+          # @option opts [Date] expiryDate The expiry date for the client
+          # @option opts [String] theme The theme of the client
+          # @option opts [Integer] priceStructureLineId The level of the price structure for the client
+          # @option opts [Integer] mentionBasedPricingMatrixLevel The amount of mentions allowed
+          # @option opts [String] postcode The postcode of the client
+          # @option opts [String] country The country of the client
+          # @option opts [String] contactName The contact name of the client
+          # @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 update_client_sub_client client_id, sub_client_id, opts
+            put "admin/clients/#{client_id}/subclient/#{sub_client_id}", opts
+          end
+          alias :update_sub_client :update_client_sub_client
+
+        end
+      end
+    end
+  end
+end