bwapi 3.0.2 → 3.1.0.pre.126

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 1d1a77ad43de02885d960a6a9327eed71eb9cd7b
-  data.tar.gz: 7490a82c7c2e76365c26fcda86f9ae6a026cce66
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGYxNTJmOThlMGVjN2JhMDQzNDI0NzI0OTI1YzBjZWRhNDA1MjMzMg==
+  data.tar.gz: !binary |-
+    MTU4OWNiNWFiYmEyYWUzYjAxNTVlYmZiY2Q1ZDVlZTNjNzMwNzYzMg==
 SHA512:
-  metadata.gz: 29d399d10311b7eebb560abc67aa63d0785e3c530dd034d2bac85d18627b87869f6eadbf92fca7a7908803109465cb3c1450bf21e5990634ca7ada952faed387
-  data.tar.gz: 5cc71bbb2cf92416e2641427a92d84be1c9b054b5d20990da1156239d84deb2c1f0dd97f7fe0fd22032617ae90ed927e5f55e64dbe637ef9b700614038e16288
+  metadata.gz: !binary |-
+    MjAzMTNjZDM4MmI0NGNjNmYwZTJkNmYwZDUxZmFhNjM0MDBiYTliZDAxZWFm
+    ZDhiMWRlMjcwNjQ4M2I4ODAwMTZiMTU1MDhkZWUyOWI1N2I2ZmM1YzU1MGFh
+    NDU1NTVjZjc1YmE5Zjc0Yjc2Njg1MDY4YWEwNjA3MzRlMzRjODE=
+  data.tar.gz: !binary |-
+    M2I0MTk1NWZiN2JjMmYyNDJjZTllNGMxMjFmMjFlYzNjMTRlNjBjNTY0ZjE4
+    ZTE0NzJlNmQxMDViMjc1YzY3Y2MyZDc1YmNmMWU5YjdmZTA4Yzg3NDhkZDBk
+    ZmE3ZjA3NGRlMTg4ZDQyMTA4M2MxMWE0NmFkNWI0NzBhOGEwMzI=

data/README.md

@@ -1,3 +1,4 @@
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/jonathanchrisp/bwapi/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 [![Gem Version](https://badge.fury.io/rb/bwapi.png)](http://badge.fury.io/rb/bwapi)
 [![Build Status](https://travis-ci.org/jonathanchrisp/bwapi.png?branch=master)](https://travis-ci.org/jonathanchrisp/bwapi)
 [![Dependency Status](https://gemnasium.com/jonathanchrisp/bwapi.png)](https://gemnasium.com/jonathanchrisp/bwapi)
@@ -14,48 +15,63 @@ A Ruby interface to the Brandwatch V2 API. The projects design is modelled on th
 http://rubydoc.info/gems/bwapi/
 
 ## Getting Started 
-All Brandwatch API calls at present require you to be authenticated with the system. Therefore you'll need to create an instance of your client: 
-
-```ruby
-bw = BWAPI::Client.new(:username => 'username@example.com', :password => 'pa$$w0rd')
-```
-   
-Once you have your instance of your client you can then use a helper method to authenticate with Brandwatch:
+All Brandwatch API calls at present require you to be authenticated, therefore you'll need to create an instance of a client and call login immediately:
 
 ```ruby
+bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd')
 bw.login
 ```
-      
-The wrapper returns a boolean value to state whether you authenticated successfully.
 
-## Example Requests
+The API returns the oauth/token response with your authentication details.
 
-Once authenticated, you are then able to make additional requests. Please see a small selection of examples below:
+### Examples
 
-### Get all projects
+Once authenticated, you are then able to make additional requests. The bwapi gem will automatically add your clients access token to the request header. Please see some examples of API requests below:
+
+#### Get all projects
 ```ruby
 bw.projects
 => #<Hashie::Mash results=[#<Hashie::Mash clientId=1856278873 clientName="JC BWAPI Demo" creationDate="2013-07-24T17:56:31.074+0000" creatorUserId=158304410 defaultIndustry="general-(recommended)" defaultLangCodes=["en"] description=nil id=1856280126 links=#<Hashie::Mash queries="http://newapi.brandwatch.com//projects/1856280126/queries.json?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f"> name="Demo Project">] resultsPage=-1 resultsPageSize=-1 resultsTotal=-1>
 ```
 
-### Get a specific project
+#### Get a specific project
 ```ruby
 bw.project 1856280126
 => #<Hashie::Mash clientId=1856278873 clientName="JC BWAPI Demo" creationDate="2013-07-24T17:56:31.074+0000" creatorUserId=158304410 defaultIndustry="general-(recommended)" defaultLangCodes=["en"] description=nil id=1856280126 links=#<Hashie::Mash queries="http://newapi.brandwatch.com//projects/1856280126/queries.json?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f"> name="Demo Project">
 ```
 
-### Get a project queries summary
+#### Get a project queries summary
 ```ruby
 bw.queries_summary 1856280126
 => #<Hashie::Mash results=[#<Hashie::Mash id=1856280351 name="LA Lakers">] resultsPage=-1 resultsPageSize=-1 resultsTotal=-1>
 ```
 
-### Get user information
+#### Get user information
 ```ruby
 bw.me
 => #<Hashie::Mash client=#<Hashie::Mash id=1856278873 name="JC BWAPI Demo" parentId=-1 railsEnabled=false theme="brandwatch"> firstName="BWAPI" id=158304410 lastName="Demo" links=#<Hashie::Mash logout="http://newapi.brandwatch.com/logout?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f" user="http://newapi.brandwatch.com//user.json?access_token=bd405bd7-9d1f-4c3d-ab5c-64b77791ae7f"> tags=#<Hashie::Mash notify="true"> uiRole="admin" username="bwapi_demo=jonathan@brandwatch.com">
 ```
 
+### Debug
+In order to see the requests and responses which are being requested and returned, you can enable debug by passing this in as an option when creating your client instance:
+
+```ruby
+bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd', debug: true)
+```
+
+Once enabled a `bwapi.log` file will be created in the current directory. Please note that you can access the log from your client also:
+
+```ruby
+bw.log.info 'logging information'
+```
+
+The above will only work if you enabled debug when creating your client.
+
+## Contributing
+If you would like to contribute to this project please fork, create your new feature and then submit a PR merging into the `staging` branch. Once the feature is merged I'll update the version number and date in the gemspec and merge to master. 
+
+Once the staging branch is merged into master a pre-release gem will automatically be created via travis. Subject to no issues being found the new version of the gem will be pushed to RubyGems.
+
 ## Tests
 There are a number of unit tests which are included as part of this project, please run:
 

data/bwapi.gemspec

@@ -4,7 +4,7 @@ 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-12-10'
+  s.date        = '2013-12-20'
   s.summary     = 'Brandwatch API Wrapper'
   s.description = 'A Ruby wrapper for the Brandwatch API'
   s.author      = 'Jonathan Chrisp'

data/lib/bwapi/client.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 require 'bwapi/authentication'
 require 'bwapi/connection'
 require 'bwapi/request'
@@ -22,9 +24,10 @@ module BWAPI
   class Client
 
     attr_accessor *Configuration::OPTION_KEYS
+    attr_reader :log
 
     def initialize opts={}
-      # Merge opts
+      @log = Logger.new("#{Dir::pwd}/bwapi.log") if opts[:debug] == true
       opts = BWAPI.options.merge opts
 
       # Create instance variables

data/lib/bwapi/client/projects.rb

@@ -2,6 +2,7 @@ require 'bwapi/client/projects/categories'
 require 'bwapi/client/projects/data'
 require 'bwapi/client/projects/data_download'
 require 'bwapi/client/projects/facebook_queries'
+require 'bwapi/client/projects/twitter_queries'
 require 'bwapi/client/projects/signals'
 require 'bwapi/client/projects/summary'
 require 'bwapi/client/projects/sharing'
@@ -80,6 +81,7 @@ module BWAPI
       include BWAPI::Client::Projects::Data
       include BWAPI::Client::Projects::DataDownload
       include BWAPI::Client::Projects::FacebookQueries
+      include BWAPI::Client::Projects::TwitterQueries
       include BWAPI::Client::Projects::Signals
       include BWAPI::Client::Projects::Summary
       include BWAPI::Client::Projects::Sharing

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

@@ -4,7 +4,7 @@ module BWAPI
       # FacebookQueries module for projects/facebookqueries endpoints
       module FacebookQueries
 
-        # Get all facebook queries in project
+        # Get all facebook queries in a project
         #
         # @param project_id [Integer] Id of project
         # @return [Hashie::Mash] All facebook queries in project
@@ -12,40 +12,81 @@ module BWAPI
           get "projects/#{project_id}/facebookqueries"
         end
 
-        # Get a specific facebook query in project
+        # Get a specific facebook query in a project
         #
         # @param project_id [Integer] Id of project
         # @param query_id [Integer] Id of facebook query
         # @return [Hashie::Mash] Specific facebook query
-        def get_facebook_queries project_id, query_id
+        def get_facebook_query project_id, query_id
           get "projects/#{project_id}/facebookqueries/#{query_id}"
         end
-        alias :facebook_query :get_facebook_queries
+        alias :facebook_query :get_facebook_query
 
-        # Update an existing facebook query in project
+        # Create a facebook query in a project
         #
         # @param project_id [Integer] Id of project
-        # @param query_id [Integer] Id of query
         # @param opts [Hash] options hash of parameters
         # @option opts [Integer] id Id of the query
+        # @option opts [String] name Name of the query
+        # @option opts [Boolean] authorised Is query authorised
+        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
+        # @option opts [Array] contextTerms Content terms of the query
+        # @option opts [Array] excludedTerms Excluded terms of thequery
+        # @option opts [Array] includedTerms Included terms of terms query
+        # @option opts [Date] creationDate Date the query was created on
+        # @option opts [Integer] dailyLimit Daily limit of the query
+        # @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status
         # @option opts [Integer] facebookPageId Id of the facebook page
-        # @option opts [String] name Name of the project
         # @option opts [String] facebookPageName Name of the facebook page
-        # @option opts [String] facebookPageURL URL of the facebook page
-        # @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status
-        # @option opts [Integer] dailyLimit Daily limit of the query
-        # @option opts [Integer] twitterLimit Twitter limit of the query
-        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
+        # @option opts [Boolean] failed Triggered too many Facebook API request failures
+        # @option opts [String] industry Industry of the query
+        # @option opts [Array] languages Query languages set
+        # @option opts [Date] lastModificationDate Last modification date of the query
         # @option opts [String] type Query type
-        # @option opts [Array] includedTerms Included terms of terms query
+        # @option opts [String] facebookConsumerKey Facebook consumer key
+        # @option opts [String] facebookAccessToken Facebook access token
+        # @return [Hashie::Mash] New facebook query
+        def create_facebook_query project_id, opts={}
+          post "projects/#{project_id}/facebookqueries", opts
+        end
+
+        # Authorise facebook queries in a project
+        #
+        # @param project_id [Integer] Id of project
+        # @param opts [Hash] options hash of facebook query oauth dto
+        # @option opts [String] accessToken Facebook access token
+        # @option opts [String] consumerKey Facebook consumer key
+        # @option opts [Array] queryIds Array of query ids
+        # @return [Hashie::Mash] Authorised facebook queries
+        def authorise_facebook_queries project_id, opts={}
+          post "projects/#{project_id}/facebookqueries/authorise", opts
+        end
+
+        # Update an existing facebook query in a project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of query
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the query
+        # @option opts [String] name Name of the query
+        # @option opts [Boolean] authorised Is query authorised
+        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
         # @option opts [Array] contextTerms Content terms of the query
         # @option opts [Array] excludedTerms Excluded terms of thequery
-        # @option opts [Array] languages Query languages
-        # @option opts [String] twitterScreenName Tracked twitter screen name
-        # @option opts [String] industry Industry of the query
+        # @option opts [Array] includedTerms Included terms of terms query
         # @option opts [Date] creationDate Date the query was created on
-        # @option opts [Date] lastModificationDate Modification date of the query
-        # @return [Hashie::Mash] Updated query
+        # @option opts [Integer] dailyLimit Daily limit of the query
+        # @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status
+        # @option opts [Integer] facebookPageId Id of the facebook page
+        # @option opts [String] facebookPageName Name of the facebook page
+        # @option opts [Boolean] failed Triggered too many Facebook API request failures
+        # @option opts [String] industry Industry of the query
+        # @option opts [Array] languages Query languages set
+        # @option opts [Date] lastModificationDate Last modification date of the query
+        # @option opts [String] type Query type
+        # @option opts [String] facebookConsumerKey Facebook consumer key
+        # @option opts [String] facebookAccessToken Facebook access token
+        # @return [Hashie::Mash] Updated facebook query
         def update_facebook_query project_id, query_id, opts={}
           put "projects/#{project_id}/facebookqueries/#{query_id}", opts
         end

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

@@ -35,6 +35,7 @@ module BWAPI
           # @option opts [String] name Name of the stream
           # @option opts [String] created Creation date of stream
           # @option opts [String] filter Filter of the stream
+          # @option opts [String] settings Settings of the stream
           # @option opts [String] lastModified Last modification date of stream
           # @return [Hashie::Mash] Specific stream
           def create_stream project_id, stream_dashboard_id, opts={}
@@ -51,6 +52,7 @@ module BWAPI
           # @option opts [String] name Name of the stream
           # @option opts [String] created Creation date of stream
           # @option opts [String] filter Filter of the stream
+          # @option opts [String] settings Settings of the stream
           # @option opts [String] lastModified Last modification date of stream
           # @return [Hashie::Mash] Updated stream
           def update_stream project_id, stream_dashboard_id, stream_id, opts={}
@@ -71,4 +73,4 @@ module BWAPI
       end
     end
   end
-end
+end

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

@@ -0,0 +1,85 @@
+module BWAPI
+  class Client
+    module Projects
+      # TwitterQueries module for projects/twitterqueries endpoints
+      module TwitterQueries
+
+        # Get all twitter queries in a project
+        #
+        # @param project_id [Integer] Id of project
+        # @return [Hashie::Mash] All twitter queries in project
+        def twitter_queries project_id
+          get "projects/#{project_id}/twitterqueries"
+        end
+
+        # Get a specific twitter query in a project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of twitter query
+        # @return [Hashie::Mash] Specific twitter query
+        def get_twitter_query project_id, query_id
+          get "projects/#{project_id}/twitterqueries/#{query_id}"
+        end
+        alias :twitter_query :get_twitter_query
+
+        # Create a twitter query in a project
+        #
+        # @param project_id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the query
+        # @option opts [String] name Name of the query
+        # @option opts [Boolean] authorised Is query authorised
+        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
+        # @option opts [Array] contextTerms Content terms of the query
+        # @option opts [Array] excludedTerms Excluded terms of thequery
+        # @option opts [Array] includedTerms Included terms of terms query
+        # @option opts [Date] creationDate Date the query was created on
+        # @option opts [Integer] dailyLimit Daily limit of the query
+        # @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status
+        # @option opts [Integer] facebookPageId Id of the facebook page
+        # @option opts [String] facebookPageName Name of the facebook page
+        # @option opts [Boolean] failed Triggered too many Facebook API request failures
+        # @option opts [String] industry Industry of the query
+        # @option opts [Array] languages Query languages set
+        # @option opts [Date] lastModificationDate Last modification date of the query
+        # @option opts [String] type Query type
+        # @option opts [String] twitterLimit Twitter limit
+        # @option opts [String] twitterScreenName Twitter screen name
+        # @return [Hashie::Mash] New twitter query
+        def create_twitter_query project_id, opts={}
+          post "projects/#{project_id}/twitterqueries", opts
+        end
+
+        # Update an existing twitter query in a project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of query
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the query
+        # @option opts [String] name Name of the query
+        # @option opts [Boolean] authorised Is query authorised
+        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
+        # @option opts [Array] contextTerms Content terms of the query
+        # @option opts [Array] excludedTerms Excluded terms of thequery
+        # @option opts [Array] includedTerms Included terms of terms query
+        # @option opts [Date] creationDate Date the query was created on
+        # @option opts [Integer] dailyLimit Daily limit of the query
+        # @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status
+        # @option opts [Integer] facebookPageId Id of the facebook page
+        # @option opts [String] facebookPageName Name of the facebook page
+        # @option opts [Boolean] failed Triggered too many Facebook API request failures
+        # @option opts [String] industry Industry of the query
+        # @option opts [Array] languages Query languages set
+        # @option opts [Date] lastModificationDate Last modification date of the query
+        # @option opts [String] type Query type
+        # @option opts [String] twitterLimit Twitter limit
+        # @option opts [String] twitterScreenName Twitter screen name
+        # @return [Hashie::Mash] Updated twitter query
+        def update_twitter_query project_id, query_id, opts={}
+          put "projects/#{project_id}/twitterqueries/#{query_id}", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/bwapi/configuration.rb

@@ -18,7 +18,8 @@ module BWAPI
       :client_secret,
       :verify_ssl,
       :netrc,
-      :netrc_file
+      :netrc_file,
+      :debug
     ].freeze
 
     DEFAULT_ADAPTER       = Faraday.default_adapter
@@ -59,6 +60,7 @@ module BWAPI
       self.verify_ssl          = true
       self.netrc               = false
       self.netrc_file          = DEFAULT_NETRC_FILE
+      self.debug               = false
     end
   end
 end

data/lib/bwapi/request.rb

@@ -91,6 +91,22 @@ module BWAPI
         end
       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?
+
+        unless response.env[:body].nil?
+          if response.env[:body].is_a? Hash
+            log.info 'Response body: %s' % response.env[:body].to_json
+          else
+            log.info 'Response body: %s' % response.env[:body]
+          end
+        end
+      end
+
       response
     end
   end

data/lib/bwapi/version.rb

@@ -1,3 +1,3 @@
 module BWAPI
-  VERSION = "3.0.2"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0.pre.126
 platform: ruby
 authors:
 - Jonathan Chrisp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -157,6 +157,7 @@ files:
 - lib/bwapi/client/projects/stream_dashboards/streams.rb
 - lib/bwapi/client/projects/summary.rb
 - lib/bwapi/client/projects/tags.rb
+- lib/bwapi/client/projects/twitter_queries.rb
 - lib/bwapi/client/projects/users.rb
 - lib/bwapi/client/projects/workflow.rb
 - lib/bwapi/client/query_validation.rb
@@ -186,17 +187,17 @@ 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 API Wrapper