pmp 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 967b6fcc653a652190480ecf5adb50f25fdee49b
-  data.tar.gz: 7e41ed111ce829ad2b876f3dacc619fde4112250
+  metadata.gz: ccd9974d908a4e63fce21f4e629dba99d8ffb964
+  data.tar.gz: da91fd91c23b1c07091ded1f7f60d504c552e2a7
 SHA512:
-  metadata.gz: 864ccef40568b132f5da9da1def8c99a6d681348ddf213d4c5361d646c73a5f2609062b1a87a0457c75aeecd6756aef5fda926721c31b37caebfa8f98d0cab64
-  data.tar.gz: f3139d704838d3480da9003478458b3df76278eef5b08ff9a753514b41ad9d63dc1700d165e9c714b966e2619613d8ad95c7511514ed201605ad28e68c049d46
+  metadata.gz: e57d28e41caf69a6d76732d59d8c0f05e5e0c0c1f61551fa5df046b4c945301e988dab00724ebc868b9ff144374dc01f3d86eb1919695103ca6216bfa1b96e54
+  data.tar.gz: 39a229cd3c8f8f7d2fca39e3b9f7a3fc880a8d286c307af0b7b403ed389544c310e9063cd6ab898ee151ee4b76715204b95254bb11a6cdcdfc35667e1bd98bea

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.DS_Store

data/README.md

@@ -1,13 +1,16 @@
-# PMP gem
+# PMP (Public Media Platform)
 
 [![Build Status](https://travis-ci.org/PRX/pmp.png)](https://travis-ci.org/PRX/pmp)
 [![Coverage Status](https://coveralls.io/repos/PRX/pmp/badge.png)](https://coveralls.io/r/PRX/pmp)
+[![Dependency Status](https://gemnasium.com/PRX/pmp.png)](https://gemnasium.com/PRX/pmp)
+[![Gem Version](https://badge.fury.io/rb/pmp.png)](http://badge.fury.io/rb/pmp)
 
-Gem to make it easier to use the PMP API, which is a hypermedia API using the collection.doc+json format.
+Gem to make it easier to use the PMP (Public Media Platform) API, which is a hypermedia API using the collection.doc+json format.
+
+You can learn more about the PMP here:
 
 https://github.com/publicmediaplatform/pmpdocs/wiki
 
-Very big hat tip to the hyperresource gem: https://github.com/gamache/hyperresource
 
 
 ## Installation
@@ -26,11 +29,14 @@ Or install it yourself as:
 
 ## Usage
 
-You can go through the `PMP::Client` as a convenience or start with a `PMP::CollectionDocument`
+You should usually go through the `PMP::Client` as a convenience or start with a `PMP::CollectionDocument`.
+
+Below is a basic guide, you can also [see the examples for more info](example/).
+
 
 ```ruby
 
-# so you need a few things, like the endpoint, default is "https://api.pmp.io"
+# so you need a few things, like the endpoint, but default is "https://api.pmp.io"
 endpoint = "https://api-sandbox.pmp.io"
 
 # and you need credentials, the gem doesn't help you create these (yet)
@@ -67,17 +73,21 @@ puts root.guid
 puts root.links.keys.sort
 > ["creator", "edit", "navigation", "query"]
 
+# don't feel like getting root first? Methods on the client get passed on to root
+puts pmp.links.keys.sort
+> ["creator", "edit", "navigation", "query"]
+
 # want to get the creator link?
-puts root.links["creator"]
+puts pmp.links["creator"]
 > #<PMP::Link href="https://api-sandbox.pmp.io/docs/af676335-21df-4486-ab43-e88c1b48f026">
 
 # get the same thing as a method
-puts root.creator
+puts pmp.creator
 > #<PMP::Link href="https://api-sandbox.pmp.io/docs/af676335-21df-4486-ab43-e88c1b48f026">
 
 # like the root doc itself, this is lazy loaded
 # but ask for an attribute on there, and you'll get the doc loaded up
-puts root.creator.guid
+puts pmp.creator.guid
 
 #### http get request to link href occurs, loads info about the creator
 > 'af676335-21df-4486-ab43-e88c1b48f026'
@@ -89,7 +99,6 @@ puts root.creator.guid
 Once you have a doc, you can save or delete it like so:
 
 ```ruby
-
 # create a new blank doc, will generatr a guid automatically if not present
 doc = PMP::CollectionDocument.new()
 doc.title = "this is an example, ok?"
@@ -119,9 +128,11 @@ doc.save
 
 # never mind, delete it
 doc.delete
+```
 
+# Credits
 
-```
+Very big hat tip to the hyperresource gem: https://github.com/gamache/hyperresource
 
 ## To Do
 
@@ -129,7 +140,6 @@ Think about integrating this lovely json schema parsing project: https://github.
 
 or this one: https://github.com/hoxworth/json-schema
 
-
 ## Contributing
 
 1. Fork it

data/example/permissions_result.txt

@@ -1073,5 +1073,3 @@ retrieved: {
 
 
 Step 5 complete, all done!
-
-[12:06:55][andrew][~/dev/projects/pmp/pmp]> 

data/lib/pmp/collection_document.rb

@@ -126,6 +126,7 @@ module PMP
       if !oauth_token
         token = PMP::Token.new(current_options).get_token
         self.oauth_token = token.token
+        self.token_type  = token.params['token_type']
       end
     end
 

data/lib/pmp/configuration.rb

@@ -13,6 +13,7 @@ module PMP
       :client_id,
       :client_secret,
       :oauth_token,
+      :token_type,
       :adapter,
       :endpoint,
       :user_agent,
@@ -31,6 +32,8 @@ module PMP
     
     # The value sent in the http header for 'User-Agent' if none is set
     DEFAULT_USER_AGENT    = "PMP Ruby Gem #{PMP::VERSION}".freeze
+
+    DEFAULT_TOKEN_TYPE    = 'Bearer'
     
     # debug is defaulted to the ENV['DEBUG'], see below
 
@@ -76,6 +79,7 @@ module PMP
       self.adapter       = DEFAULT_ADAPTER
       self.endpoint      = DEFAULT_ENDPOINT
       self.user_agent    = DEFAULT_USER_AGENT
+      self.token_type    = DEFAULT_TOKEN_TYPE
       self.debug         = ENV['DEBUG']
       self
     end

data/lib/pmp/connection.rb

@@ -14,6 +14,7 @@ module PMP
       :adapter,
       :ssl,
       :oauth_token,
+      :token_type,
       :basic_auth,
       :user,
       :password,
@@ -27,7 +28,7 @@ module PMP
         if opts[:basic_auth] && opts[:user] && opts[:password]
           faraday.request :basic_auth, opts[:user], opts[:password]
         elsif opts[:oauth_token]
-          faraday.request :authorization, 'Bearer', opts[:oauth_token]
+          faraday.request :authorization, opts[:token_type], opts[:oauth_token]
         end
 
         faraday.request :multipart

data/lib/pmp/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module PMP
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/token_spec.rb

@@ -35,6 +35,7 @@ describe PMP::Token do
     token_api= PMP::Token.new(client_id: client_id, client_secret: client_secret, endpoint: endpoint)
     token = token_api.get_token
     token.token.must_equal access_token
+    token.params['token_type'].must_equal 'Bearer'
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmp
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Andrew Kuklewicz