pmp 0.1.0

data/spec/fixtures/collection_root.json

@@ -0,0 +1,178 @@
+{
+    "attributes": {
+        "created": "2013-10-01T15:57:55+00:00",
+        "guid": "04224975-e93c-4b17-9df9-96db37d318f3",
+        "modified": "2013-10-04T14:45:34+00:00",
+        "published": "2013-07-04T04:00:44+00:00",
+        "title": "PMP Home Document",
+        "valid": {
+            "from": "2013-07-04T04:00:44+00:00",
+            "to": "3013-07-04T04:00:44+00:00"
+        }
+    },
+    "links": {
+        "creator": [
+            {
+                "href": "https://api-sandbox.pmp.io/docs/af676335-21df-4486-ab43-e88c1b48f026"
+            }
+        ],
+        "edit": [
+            {
+                "href": "https://publish-sandbox.pmp.io/docs",
+                "method": "PUT"
+            }
+        ],
+        "navigation": [
+            {
+                "href": "https://api-sandbox.pmp.io/docs?guid=04224975-e93c-4b17-9df9-96db37d318f3",
+                "rels": [
+                    "urn:pmp:navigation:self"
+                ]
+            }
+        ],
+        "query": [
+            {
+                "hints": {
+                    "allow": [
+                        "GET"
+                    ]
+                },
+                "href-template": "https://api-sandbox.pmp.io/users{?limit,offset,tag,collection,text,searchsort,has}",
+                "href-vars": {
+                    "collection": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "has": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "limit": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "offset": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "searchsort": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "tag": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "text": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval"
+                },
+                "rels": [
+                    "urn:pmp:query:users"
+                ],
+                "title": "Query for users"
+            },
+            {
+                "hints": {
+                    "allow": [
+                        "GET"
+                    ]
+                },
+                "href-template": "https://api-sandbox.pmp.io/groups{?limit,offset,tag,collection,text,searchsort,has}",
+                "href-vars": {
+                    "collection": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "limit": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "offset": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "searchsort": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "tag": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "text": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval"
+                },
+                "rels": [
+                    "urn:pmp:query:groups"
+                ],
+                "title": "Query for groups"
+            },
+            {
+                "hints": {
+                    "allow": [
+                        "GET",
+                        "PUT",
+                        "DELETE"
+                    ]
+                },
+                "href-template": "https://api-sandbox.pmp.io/profiles{/guid}",
+                "href-vars": {
+                    "guid": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval"
+                },
+                "rels": [
+                    "urn:pmp:hreftpl:profiles"
+                ],
+                "title": "Access profiles"
+            },
+            {
+                "hints": {
+                    "allow": [
+                        "GET",
+                        "PUT",
+                        "DELETE"
+                    ]
+                },
+                "href-template": "https://api-sandbox.pmp.io/schemas{/guid}",
+                "href-vars": {
+                    "guid": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval"
+                },
+                "rels": [
+                    "urn:pmp:hreftpl:schemas"
+                ],
+                "title": "Access schemas",
+                "type": "application/schema+json"
+            },
+            {
+                "hints": {
+                    "allow": [
+                        "GET",
+                        "PUT",
+                        "DELETE"
+                    ]
+                },
+                "href-template": "https://api-sandbox.pmp.io/docs{/guid}{?limit,offset}",
+                "href-vars": {
+                    "guid": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "limit": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "offset": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval"
+                },
+                "rels": [
+                    "urn:pmp:hreftpl:docs"
+                ],
+                "title": "Access documents"
+            },
+            {
+                "hints": {
+                    "allow": [
+                        "GET"
+                    ]
+                },
+                "href-template": "https://api-sandbox.pmp.io/docs{?limit,offset,tag,collection,text,searchsort,has,author,distributor,distributorgroup,startdate,enddate,profile,language}",
+                "href-vars": {
+                    "author": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "collection": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "distributor": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "distributorgroup": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "enddate": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "has": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "language": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "limit": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "offset": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "profile": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "searchsort": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "startdate": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "tag": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                    "text": "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval"
+                },
+                "rels": [
+                    "urn:pmp:query:docs"
+                ],
+                "title": "Query for documents"
+            },
+            {
+                "href": "https://api-sandbox.pmp.io/guids",
+                "method": "POST",
+                "rels": [
+                    "urn:pmp:query:guids"
+                ],
+                "title": "Generate guids",
+                "type": "application/json"
+            },
+            {
+                "href": "https://publish-sandbox.pmp.io/files",
+                "method": "POST",
+                "rels": [
+                    "urn:pmp:query:files"
+                ],
+                "title": "Upload media files",
+                "type": "multipart/form-data"
+            }
+        ]
+    },
+    "version": "1.0"
+}

data/spec/link_spec.rb

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'pmp/link'
+
+require 'webmock/minitest'
+
+describe PMP::Link do
+
+  before(:each) {
+    @parent = Minitest::Mock.new
+    @info = {'href' => 'http://api-sandbox.pmp.io/docs/'}
+    @link = PMP::Link.new(@parent, @info)
+  }
+
+  it "can create a new link" do
+    @link.wont_be_nil
+  end
+
+  it "can save params to attributes" do
+    @link.href.must_equal 'http://api-sandbox.pmp.io/docs/'
+  end
+
+  it "can retrieve link resource" do
+    @link.href.must_equal 'http://api-sandbox.pmp.io/docs/'
+  end
+
+  it "can become json" do
+    @link.as_json.must_equal @info
+  end
+
+  it "gets a url based on an href string" do
+    @link.url.must_equal 'http://api-sandbox.pmp.io/docs/'
+  end
+
+  it "can get a link for templated href" do
+    l = {
+            "hints" => {
+                "allow" => [
+                    "GET"
+                ]
+            },
+            "href-template" => "https://api-sandbox.pmp.io/docs{?limit,offset,tag,collection,text,searchsort,has,author,distributor,distributorgroup,startdate,enddate,profile,language}",
+            "href-vars" => {
+                "author" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "collection" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "distributor" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "distributorgroup" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "enddate" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "has" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "language" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "limit" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "offset" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "profile" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "searchsort" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "startdate" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "tag" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval",
+                "text" => "https://github.com/publicmediaplatform/pmpdocs/wiki/Content-Retrieval"
+            },
+            "rels" => [
+                "urn:pmp:query:docs"
+            ],
+            "title" => "Query for documents"
+        }
+
+    @link = PMP::Link.new(@parent, l)
+    @link.hints.must_equal l['hints']
+    @link.url.must_equal "https://api-sandbox.pmp.io/docs"
+    @link.where('limit' => 10).url.must_equal "https://api-sandbox.pmp.io/docs?limit=10"
+    @link.url.must_equal "https://api-sandbox.pmp.io/docs"
+  end
+
+end

data/spec/links_spec.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'pmp/links'
+
+
+describe PMP::Links do
+
+  before(:each) {
+    @parent = Minitest::Mock.new    
+    @links = PMP::Links.new(@parent)
+  }
+
+  it "can create a new links obj" do
+    @links.wont_be_nil
+  end
+
+  it "can access _parent" do
+    @links.parent = {}
+    @links.parent.wont_be_nil
+  end
+
+  it "can have a link assigned" do
+    link = {}
+    @parent.expect(:foo=, link, Array(Object))
+    @links['foo'] = link
+    @links['foo'].must_equal link
+  end
+
+end

data/spec/parser_spec.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'ostruct'
+
+require 'pmp/parser'
+
+class TestParser < OpenStruct
+  include PMP::Parser
+
+  attr_accessor :version
+
+  def links
+    @links ||= PMP::Links.new(self)
+  end
+
+  def attributes
+    marshal_dump.delete_if{|k,v| links.keys.include?(k)}
+  end
+
+end
+
+describe PMP::Parser do
+
+  it "will not parse nil document" do
+    tc = TestParser.new
+    tc.parse(nil)
+  end
+
+  it "will un-parse to hash for json serialization" do
+    tc = TestParser.new
+    tc.parse(json_fixture(:collection_basic))
+    hash = tc.as_json
+    # puts "basic as_json: #{hash}"
+    hash.keys.sort.must_equal ['attributes', 'links', 'version']
+    hash['attributes']['guid'].must_equal "f84e9018-5c21-4b32-93f8-d519308620f0"
+    hash['links'].keys.sort.must_equal ["collection", "profile", "self"]
+  end
+
+  it "parses query links into a hash based on rels" do
+    tc = TestParser.new
+    tc.parse(json_fixture(:collection_root))
+    tc.query.must_be_instance_of Hash
+    tc.query.keys.sort.must_equal ["urn:pmp:hreftpl:docs", "urn:pmp:hreftpl:profiles", "urn:pmp:hreftpl:schemas", "urn:pmp:query:docs", "urn:pmp:query:files", "urn:pmp:query:groups", "urn:pmp:query:guids", "urn:pmp:query:users"]
+  end
+
+
+end

data/spec/response_spec.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'ostruct'
+
+require 'pmp/response'
+
+describe PMP::Response do
+
+  before {
+    @raw = Minitest::Mock.new
+    @raw.expect(:status, 200)
+    @request = {}
+  }
+
+  it "can make a new response" do
+    response = PMP::Response.new(@raw, @request)
+  end
+
+  it "can raise an error" do
+    raw = Minitest::Mock.new
+    raw.expect(:status, 500).expect(:status, 500)
+    proc{ PMP::Response.new(raw, @request) }.must_raise RuntimeError
+  end
+
+  it "can return body" do
+    @raw.expect(:body, {foo: 'bar'})
+    response = PMP::Response.new(@raw, @request)
+    response.body[:foo].must_equal 'bar'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+require 'simplecov'
+SimpleCov.command_name 'Unit Tests'
+SimpleCov.start
+
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/mock'
+require 'webmock/minitest'
+require 'hashie/mash'
+
+require 'pmp'
+
+# helper method to create mashified test docs, that look like what comes out of the faraday middleware
+def mashify(body)
+  case body
+  when Hash
+    ::Hashie::Mash.new(body)
+  when Array
+    body.map { |item| parse(item) }
+  else
+    body
+  end
+end
+
+def json_fixture(name)
+  mashify(JSON.parse(json_file(name)))
+end
+
+def json_file(name)
+  File.read( File.dirname(__FILE__) + "/fixtures/#{name}.json")
+end

data/spec/token_spec.rb

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'pmp/token'
+
+require 'webmock/minitest'
+
+describe PMP::Token do
+
+  it "gets the base path for this subclass of API" do
+    token = PMP::Token.new
+    token.token_url.must_equal '/auth/access_token'
+  end
+
+  it "gets an access_token" do
+    access_token = "thisisnotanaccesstokenno"
+    response_body = {
+      access_token: access_token,
+      token_type: "Bearer",
+      token_issue_date: DateTime.now,
+      token_expires_in: 24*60*60
+    }.to_json
+                            
+    stub_request(:post, "https://api-sandbox.pmp.io/auth/access_token").
+      with(:body => {"grant_type"=>"client_credentials"},
+           :headers => {'Accept'=>'application/json', 'Authorization'=>'Basic dGhpc2lzbm90YS1yZWFsLWNsaWVudC1pZC1zb3Zlcnlzb3JyeTp0aGlzaXNub3RhcmVhbHNlY3JldGVpdGhlcg==', 'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'api-sandbox.pmp.io:443'}).
+      to_return(:status => 200, :body => response_body, :headers => {'Content-Type' => 'application/json; charset=utf-8'})
+
+    client_id = "thisisnota-real-client-id-soverysorry"
+    client_secret = "thisisnotarealsecreteither"
+    endpoint = "https://api-sandbox.pmp.io"
+    token_path = '/auth/access_token'
+    
+    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
+  end
+
+end