bwapi 9.0.0.pre.364 → 9.0.0.pre.365

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjJlMmJiYWUwMDE3ZjlhNmRmMDE5NGZmZWVlYWZiYmQ3MjQ3Y2YwYg==
+    Njc4YjUwZTIyNWQzMDFlMDQzMTE3MjQ1MmY1MDk2MTA0ZDgzNTFkOA==
   data.tar.gz: !binary |-
-    YTIzMjA0ZWU3NmYxYjgxY2FlMjg5ZTc2ODg3MGVkNTgzYzYxZGJiYQ==
+    ZDRhNzU0ZmNiNjc4ODNmZDQxM2Q0NTlhZmJmNWYxOThkMTJkNzdlOQ==
 SHA512:
   metadata.gz: !binary |-
-    NmIyNGY1YzEzNTg2NmY5MGVjMDczNTg0ODlkNGU0MzZlYjdmOTBkZDliYzcx
-    MDk1ZTU3NjMyMmVmMDNhNjdlMjY2MDYwY2MyYTM3YjMyYmI4NTRkMzFmN2E4
-    NTEzMzE4MzcyYWE2MWI5MDc2YTg1ZTU2ZGU2MzZjZWQyOWFlZDI=
+    MTNmY2Q0NDQ5YzM2ZjU5NTEwOTVjNTFlYjkyMWEyNzEyMDg4ZWYwNzgxMjEy
+    M2ExMTc1MTVjYmZiMTllZWY1OWYzZDIwMGU3ZmQ0NDJiY2FiNDZkN2UxOWFi
+    NzM2ZTVlYjA4MTkzY2QzZWFhOWRhNDY1ZDU5OWM2ZDM1N2RhZDY=
   data.tar.gz: !binary |-
-    ZDZlMTc5YTA5MDRiZjIwYmEwZjJmM2M0M2ZlZmI3NThkOTVhMjdiM2QwNzM2
-    YTEyM2IxNTEwOTczYWFjYTc4NWE5NzY0NTE4N2FmMTI1Y2NlYzNhNjIxOWJi
-    ZGRlNmQ4N2UwYmNhNWZhZjBhZGU0NTNmYTNhY2U0NjI1YzMxMGM=
+    YzkwYmIzYmY0NGM4NWI1MzQ4YzY5YmY2Yzc0ZGM4OWY2OTMxMmE2N2NlODMy
+    NmYzMzU4ZTVmNTY2N2M2Yjk4NTJlOGNhMDRkNjFiNjg5OGY2YWY2YjkwODZk
+    OGVmMDEzNGNhMWRhZDkwZDQyNTkwMmZiMGRkMDRkNTllNDk0MWM=

data/README.md

@@ -23,48 +23,58 @@ bw.login
 
 The API returns the oauth/token response with your authentication details.
 
-### Examples
+## Examples
 
 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
+### Request 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
+### Request 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
+### Request 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
+### Request 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:
+## Debug Mode
+
+In order to see additional logging and performance information you can enable debug mode 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:
+### Logging
+
+Any log output will be written to STDOUT unless you define a logger:
 
 ```ruby
-bw.log.info 'logging information'
+bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd', debug: true, log: Logger.new('main.log'))
 ```
 
-The above will only work if you enabled debug when creating your client.
+### Performance
+
+When debug mode is running each request/response is timed and stored, to view the stats call the performance method on the client instance:
+
+```ruby
+bw.performance
+{"post_oauth_token"=>[0.125019], "get_me"=> [0.048003, 0.034587, 0.038165, 0.10304]}
+```
 
 ## 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bwapi
 version: !ruby/object:Gem::Version
-  version: 9.0.0.pre.364
+  version: 9.0.0.pre.365
 platform: ruby
 authors:
 - Jonathan Chrisp