bwapi 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d950eb3141a3d094f3a8acda0bcc07fbaca916ca
-  data.tar.gz: 9461dd2860680d76e8cac1ebe9ad287095ca309b
+  metadata.gz: dd2cf79cd157dd2ca6e76738c1424f1a47088df4
+  data.tar.gz: 1fac68af86ca4f7d8d210e2ca04614e53311b87d
 SHA512:
-  metadata.gz: 5f97eff77c439a33cb972012cce89bacccfbda6540f5022542e300e00e49f6e9741bb1c764acba767dee34f6773ff8314311fd02e1e84c19ee862983fe2888fa
-  data.tar.gz: fde6d236a3b0b43ea7dce59f91f2032dd83388dc5fb1aa77201aa292f60bd2c71592b0dfe21e5c4bf9f6090da406152ccdd34333531cc5d7db9e4a408cfe8f2a
+  metadata.gz: 11abad275db972f85bddf6d43dc398c255291ce65c70cc157755fe4fa1a5ffd711e053863cef5b0cbe1d8ca6e0a6d668c15587fa7a6b02f4b100588e93797860
+  data.tar.gz: a65bffa36df961516ac87aaf03566bab6439334df3bca2778ca263e255b7d14a0b56d34f7f2ce80570a64ec645a0c0bfca7e377511bdd03953b13f1e9a4af3d8

data/README.md

@@ -1,15 +1,67 @@
+[![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)
+[![Code Climate](https://codeclimate.com/github/jonathanchrisp/bwapi.png)](https://codeclimate.com/github/jonathanchrisp/bwapi)
+
 # 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.
+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.
+
+## Documentation 
+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:
+
+```ruby
+bw.login
+```
+      
+The wrapper returns a boolean value to state whether you authenticated successfully.
+
+## Example Requests
+
+Once authenticated, you are then able to make additional requests. Please see a small selection of examples 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
+```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
+```ruby
+bw.queries_summary 1856280126
+=> #<Hashie::Mash results=[#<Hashie::Mash id=1856280351 name="LA Lakers">] resultsPage=-1 resultsPageSize=-1 resultsTotal=-1>
+```
+
+### 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">
+```
 
 ## Tests
-There are a number of unit tests which are included as part of this project which are run by rspec. Please run:
+There are a number of unit tests which are included as part of this project, please run:
 
-      rspec spec
+```ruby
+rspec spec
+```
       
-Please note that a number of tests still need to be added so I don't currently have complete coverage.
+Please note that a number of tests still need to be added so I don't currently have complete coverage, subject to workload these will be slowly added over the next few months.
 
 ## Feedback
-I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com
+I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com or jonathan@brandwatch.com

data/bwapi.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   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.add_runtime_dependency 'colored', '~> 1.2'
 
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/bwapi/authentication.rb

@@ -1,4 +1,4 @@
-require 'netrc'
+require 'colored'
 
 module BWAPI
   module Authentication
@@ -29,13 +29,18 @@ module BWAPI
     # @param netrc [Boolean] Netrc status
     def netrc_credentials netrc=false
       return unless netrc
+
+      require 'netrc'
       file = Netrc.read netrc_file
 
       # Get credentials using host
       netrc_host = URI.parse(api_endpoint).host
       creds = file[netrc_host]
+      raise 'You are missing your .netrc file or the host provided has no credentials!'.red.underline if creds.nil?
       self.username = creds.shift
       self.password = creds.shift
+    rescue LoadError
+      raise "Please install netrc gem for .netrc support".red.underline
     end
 
   end

data/lib/bwapi/configuration.rb

@@ -15,12 +15,13 @@ module BWAPI
       :expires_in,
       :client_id,
       :client_secret,
+      :verify_ssl,
       :netrc,
       :netrc_file
     ].freeze
 
     DEFAULT_ADAPTER       = Faraday.default_adapter
-    DEFAULT_API_ENDPOINT  = ENV['BWAPI_API_ENDPOINT'] || 'http://newapi.brandwatch.com/'
+    DEFAULT_API_ENDPOINT  = 'https://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')
@@ -32,15 +33,12 @@ module BWAPI
       base.reset
     end
 
+    # Set configuration options using a block
     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
-
+    # Reset the configuration options
     def reset
       self.adapter             = DEFAULT_ADAPTER
       self.user_agent          = DEFAULT_USER_AGENT
@@ -52,8 +50,14 @@ module BWAPI
       self.refresh_token       = nil
       self.client_id           = DEFAULT_CLIENT_ID
       self.client_secret       = nil
+      self.verify_ssl          = true
       self.netrc               = false
       self.netrc_file          = DEFAULT_NETRC_FILE
     end
+
+    # Convert option_keys to hash and return
+    def options
+      OPTION_KEYS.inject({}){|o,k|o.merge!(k => send(k))}
+    end
   end
 end

data/lib/bwapi/connection.rb

@@ -25,7 +25,6 @@ module BWAPI
       end
 
       connection.headers[:user_agent] = user_agent
-
       connection
     end
 

data/lib/bwapi/request.rb

@@ -57,19 +57,19 @@ module BWAPI
     # @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
+        :headers => {
+          :user_agent => user_agent
+        },
+        :force_urlencoded => opts.delete(:force_urlencoded) || false,
+        :url => api_endpoint,
+        :ssl => {:verify => verify_ssl}
       }
 
       response = connection(conn_opts).send(method) do |request|
         # Add token to the header
-        if token
-          request.headers[:authorization] = "bearer #{token}"
+        if access_token
+          request.headers[:authorization] = "bearer #{access_token}"
         end
 
         case method
@@ -78,7 +78,7 @@ module BWAPI
         when :delete
           request.url path, opts
         when :patch, :post, :put
-          if force_urlencoded
+          if conn_opts[:force_urlencoded]
             request.url path, opts
           else
             request.path = path

data/lib/bwapi/version.rb

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

data/spec/bwapi/client_spec.rb

@@ -117,8 +117,8 @@ describe BWAPI::Client do
           expect(BWAPI::Client.new.netrc).to eql(false)
         end
 
-        it 'should allow a user to set a netrc value' do
-          bw = BWAPI::Client.new :netrc => true
+        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')
           expect(bw.netrc).to eql(true)
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jonathan Chrisp
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: A Ruby wrapper for the Brandwatch v2 API
 email: jonathan@brandwatch.com
 executables:
@@ -176,3 +190,4 @@ test_files:
 - spec/bwapi_spec.rb
 - spec/fixtures/.netrc
 - spec/helper.rb
+has_rdoc: