nypl-collections 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61701b0e8d3f9b9ac6901ae24bbc8acb40e013b6
+  data.tar.gz: f2c44737597bd384de9216974f41af89016ddef4
+SHA512:
+  metadata.gz: 91745dae4eb43afe74f8589c977d8eb787f5aad6b436c32e41592c775aec5f21c4df8dcb8ff3dd72296b50e8463c016c757461cc55dc22dbdc2a8c1cf01597b0
+  data.tar.gz: 8b3b26fafa1bb8c4771f919955d89814040a1e2bc672e16a076a09b4e1b075599beb366629fc7cab0d4e06480902955b48f336440555f3581ba97a8ea14fd064

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,31 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+# Use HTTParty for HTTP requests
+gem 'httparty'
+
+# Use dotenv to keep api keys private
+gem 'dotenv'
+
+gem 'rake'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+  gem "simplecov"
+  gem 'coveralls', require: false
+  gem 'shoulda-matchers'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,126 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.1)
+    dotenv (0.9.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    httpauth (0.2.0)
+    i18n (0.6.9)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    mime-types (2.0)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tins (0.13.1)
+    tzinfo (0.3.38)
+    webmock (1.16.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  coveralls
+  dotenv
+  httparty
+  jeweler (~> 1.8.7)
+  pry
+  rake
+  rdoc (~> 3.12)
+  rspec
+  shoulda
+  shoulda-matchers
+  simplecov
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Emma Spencer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+[![Build Status](https://travis-ci.org/enspencer/nypl-collections.png?branch=master)](https://travis-ci.org/enspencer/nypl-collections)[![Coverage Status](https://coveralls.io/repos/enspencer/nypl-collections/badge.png)](https://coveralls.io/r/enspencer/nypl-collections)
+
+# nypl-collections
+
+This will be a Ruby gem for the [New York Public Library Digital Collections API](http://api.repo.nypl.org/). Just got started on December 4, 2013, so check back for when it's usable, or contribute to make it happen!
+
+## Setting Up
+
+Sign up for an [API key](http://api.repo.nypl.org/) to start.
+
+Setup a new instance:
+
+```ruby
+@client = Collections::Client.new
+@client.configure do |config|
+  config.auth_token = YOUR_AUTH_TOKEN
+end
+```
+
+## Methods
+
+### return_captures_for_uuid(uuid, options= {})
+Takes a UUID for any bibliographic level, including container (a/k/a parent), collection or item-level records. Takes optional parameters of withTitles, per_page, and page.
+
+Returns all captures for a parent-level UUID or a item-level UUID, and display the uuid, imageID, itemLink and title (optional) for each capture.
+
+Example:
+
+```ruby
+@client.return_captures_for_uuid('5fa75050-c6c7-012f-e24b-58d385a7bc34', per_page: '10', page: '2')
+```
+
+returns:
+```json
+{"nyplAPI"=>
+  {"request"=>
+    {"uuid"=>"5fa75050-c6c7-012f-e24b-58d385a7bc34",
+     "perPage"=>"10",
+     "page"=>"2",
+     "totalPages"=>"13",
+     "startTime"=>"Beginning of Time",
+     "endTime"=>"Till Now"},
+   "response"=>
+    {"headers"=>{"status"=>"success", "code"=>"200", "message"=>"ok"},
+     "numResults"=>"125",
+     "capture"=>
+      [{"uuid"=>"510d47e3-6c44-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582671",
+        "sortString"=>"0000000001|0000000011|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582671",
+        "dateDigitized"=>"2012-08-16T00:34:10Z"},
+       {"uuid"=>"510d47e3-6c45-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582672",
+        "sortString"=>"0000000001|0000000012|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582672",
+        "dateDigitized"=>"2012-08-16T00:34:10Z"},
+       {"uuid"=>"510d47e3-6c46-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582673",
+        "sortString"=>"0000000001|0000000013|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582673",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"},
+       {"uuid"=>"510d47e3-6c47-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582674",
+        "sortString"=>"0000000001|0000000014|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582674",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"},
+       {"uuid"=>"510d47e3-6c48-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582675",
+        "sortString"=>"0000000001|0000000015|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582675",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"},
+       {"uuid"=>"510d47e3-6c49-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582676",
+        "sortString"=>"0000000001|0000000016|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582676",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"},
+       {"uuid"=>"510d47e3-6c4a-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582677",
+        "sortString"=>"0000000001|0000000017|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582677",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"},
+       {"uuid"=>"510d47e3-6c4b-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582678",
+        "sortString"=>"0000000001|0000000018|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582678",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"},
+       {"uuid"=>"510d47e3-6c4c-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582679",
+        "sortString"=>"0000000001|0000000019|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582679",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"},
+       {"uuid"=>"510d47e3-6c4d-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"1582680",
+        "sortString"=>"0000000001|0000000020|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?1582680",
+        "dateDigitized"=>"2012-08-16T00:34:11Z"}]}}}
+```
+### return_uuid_for_local_identifier(local_id_name, local_id_value)
+
+Takes parameters of local identifier field name and local identifier value.
+
+Returns uuid for a local identifier.Local_identifier field names can be found in the "type" attribute of the MODS <identifier> element (e.g. <identifier type="local_[identifier-field-name]">).
+
+What is MODS, you ask? [Here you go.](http://www.loc.gov/standards/mods/)
+
+Also returns page, perPage, totalPages, numResults.
+
+example: 
+```ruby
+@client.return_uuid_for_local_identifier('local_hades', '1017240')
+```
+
+returns:
+```json
+{"nyplAPI"=>
+  {"request"=>
+    {"uuid"=>"ecaf7d80-c55f-012f-e3c7-58d385a7bc34",
+     "perPage"=>"10",
+     "page"=>"1",
+     "totalPages"=>"1",
+     "startTime"=>"Beginning of Time",
+     "endTime"=>"Till Now"},
+   "response"=>
+    {"headers"=>{"status"=>"success", "code"=>"200", "message"=>"ok"},
+     "numResults"=>"2",
+     "capture"=>
+      [{"uuid"=>"510d47e2-8e15-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"836959",
+        "sortString"=>"0000000001|0000001105|0000000015|0000000001",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?836959",
+        "dateDigitized"=>"2013-02-28T20:39:36Z"},
+       {"uuid"=>"510d47e2-8e16-a3d9-e040-e00a18064a99",
+        "typeOfResource"=>"still image",
+        "imageID"=>"836960",
+        "sortString"=>"0000000001|0000001105|0000000015|0000000002",
+        "itemLink"=>"http://digitalgallery.nypl.org/nypldigital/id?836960",
+        "dateDigitized"=>"2013-02-28T20:39:36Z"}]}}}
+```
+
+## Contributing to nypl-collections
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Emma Spencer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "nypl-collections"
+  gem.homepage = "http://github.com/enspencer/nypl-collections"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem for interacting with the NYPL Digital Collections API}
+  gem.description = %Q{A gem for interacting with the NYPL Digital Collections API}
+  gem.email = "emma.n.spencer@gmail.com"
+  gem.authors = ["Emma Spencer"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nypl-collections #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 78.31
+  }
+}

data/coverage/.resultset.json

@@ -0,0 +1,193 @@
+{
+  "RSpec": {
+    "coverage": {
+      "/Users/emmaspencer/Code/rubygems/nypl-collections/lib/nypl_collections.rb": [
+        1,
+        null,
+        1,
+        1,
+        null,
+        1,
+        5,
+        null,
+        null,
+        1,
+        2,
+        2,
+        null,
+        null,
+        1,
+        0,
+        null,
+        null,
+        null
+      ],
+      "/Users/emmaspencer/Code/rubygems/nypl-collections/lib/nypl_collections/client.rb": [
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        null,
+        1,
+        1,
+        1,
+        1,
+        null,
+        1,
+        1,
+        null,
+        1,
+        3,
+        null,
+        null,
+        1,
+        2,
+        1,
+        null,
+        null,
+        null,
+        null,
+        1,
+        1,
+        1,
+        1,
+        null,
+        1,
+        null,
+        1,
+        1,
+        1,
+        null,
+        null,
+        1,
+        2,
+        null,
+        null,
+        1,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        0,
+        0,
+        0,
+        0,
+        null,
+        0,
+        null,
+        0,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        0,
+        0,
+        0,
+        0,
+        null,
+        0,
+        null,
+        0,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        0,
+        0,
+        0,
+        null,
+        0,
+        null,
+        0,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        1,
+        1,
+        1,
+        null,
+        1,
+        null,
+        1,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1
+      ],
+      "/Users/emmaspencer/Code/rubygems/nypl-collections/lib/nypl_collections/configuration.rb": [
+        1,
+        1,
+        null,
+        1,
+        null,
+        1,
+        2,
+        null,
+        null,
+        1,
+        3,
+        3,
+        null,
+        null,
+        null
+      ],
+      "/Users/emmaspencer/Code/rubygems/nypl-collections/spec/nypl_collections/configuration_spec.rb": [
+        null
+      ],
+      "/Users/emmaspencer/Code/rubygems/nypl-collections/spec/nypl_collections_spec.rb": [
+        1,
+        null,
+        1,
+        1,
+        1,
+        1,
+        null,
+        null,
+        null,
+        1,
+        1,
+        1,
+        1,
+        null,
+        null,
+        1,
+        null,
+        null,
+        null
+      ]
+    },
+    "timestamp": 1386366628
+  }
+}