nypl-collections 0.0.1

data/lib/nypl_collections.rb

@@ -0,0 +1,19 @@
+require 'nypl_collections/client'
+
+module Collections
+  class << self
+
+    def new
+      @client ||= Collections::Client.new
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/nypl_collections/client.rb

@@ -0,0 +1,122 @@
+require 'json'
+require 'httparty'
+require 'nypl_collections/configuration'
+require 'pry'
+require 'dotenv'
+Dotenv.load "../.env"
+
+module Collections
+  class Client
+    include Collections::Configuration
+    include HTTParty
+
+    BASE_URL = "http://api.repo.nypl.org/api/v1/items/"
+    BASE_URL
+
+    def initialize
+      reset
+    end
+
+    def set_urlparam(url, name, options)
+      return unless options[name]
+      url << "&#{name.to_s.gsub(/ /,'_')}=#{options[name]}"
+    end
+
+# Return all capture UUIDs, imageIDs, itemLinks and
+# titles (optional) for any UUID 
+    def return_captures_for_uuid(uuid, options= {})
+      url = BASE_URL.clone
+      token = auth_token
+      uuid = uuid
+
+      url << uuid + "?"
+
+      if options[:withTitles]
+        title = options[:withTitles]
+        url << "withTitles=#{title}"
+      end
+
+      [:per_page, :page].each do |thing|
+        set_urlparam(url, thing, options)
+      end
+
+      HTTParty.get(url,
+        :headers => {
+          "Authorization" => "Token token=#{token}"
+        })
+    end
+
+# Return uuid for a local identifier.
+# Local_identifier field names can be found in the
+# "type" attribute of the MODS <identifier> element
+    def return_uuid_for_local_identifier(local_id_name, local_id_value)
+      url = BASE_URL.clone
+      token = auth_token
+      local_id_name = local_id_name
+      local_id_value = local_id_value
+
+      url << "#{local_id_name}/#{local_id_value}"
+
+      HTTParty.get(url,
+        :headers => {
+          "Authorization" => "Token token=#{token}"
+        })
+    end
+
+
+# search in fields: identifier, typeOfResource, note
+# title, namePart, place, publisher, topic,
+# geographic, temporal, genre, physicalLocation, and shelfLocator
+# enter search_terms 
+    def search_in_mods_field(search_terms, field)
+      url = BASE_URL.clone
+      token = auth_token
+      search_terms = search_terms.gsub(/ /, "-").gsub(/_/, "-")
+      field = field
+
+      url << "search?q=#{search_terms}&field=#{field}"
+
+      HTTParty.get(url,
+        :headers => {
+          "Authorization" => "Token token=#{token}"
+        })
+    end
+
+# same as search_in_mods_fields but don't need to specify a field
+    def search_all_mods_fields(search_terms)
+      url = BASE_URL.clone
+      token = auth_token
+      search_terms = search_terms.gsub(/ /, "-").gsub(/_/, "-")
+
+      url << "search?q=#{search_terms}"
+
+      HTTParty.get(url,
+        :headers => {
+          "Authorization" => "Token token=#{token}"
+        })
+    end
+
+    def return_mods_record_for_capture_uuid(uuid)
+      url = BASE_URL.clone
+      token = auth_token
+      uuid = uuid
+
+      url << "mods/#{uuid}"
+
+      HTTParty.get(url,
+        :headers => {
+          "Authorization" => "Token token=#{token}"
+        })
+
+    end
+
+  end
+end
+
+
+# @client = Collections::Client.new
+# @client.configure do |config|
+#   config.auth_token = ENV['AUTH_TOKEN']
+#   binding.pry
+# end
+binding.pry

data/lib/nypl_collections/configuration.rb

@@ -0,0 +1,15 @@
+module Collections
+  module Configuration
+    
+    attr_accessor :auth_token
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.auth_token = nil
+      self
+    end
+  end
+end

data/nypl-collections.gemspec

@@ -0,0 +1,103 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "nypl-collections"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Emma Spencer"]
+  s.date = "2013-12-12"
+  s.description = "A gem for interacting with the NYPL Digital Collections API"
+  s.email = "emma.n.spencer@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "coverage/.last_run.json",
+    "coverage/.resultset.json",
+    "coverage/assets/0.8.0/application.css",
+    "coverage/assets/0.8.0/application.js",
+    "coverage/assets/0.8.0/colorbox/border.png",
+    "coverage/assets/0.8.0/colorbox/controls.png",
+    "coverage/assets/0.8.0/colorbox/loading.gif",
+    "coverage/assets/0.8.0/colorbox/loading_background.png",
+    "coverage/assets/0.8.0/favicon_green.png",
+    "coverage/assets/0.8.0/favicon_red.png",
+    "coverage/assets/0.8.0/favicon_yellow.png",
+    "coverage/assets/0.8.0/loading.gif",
+    "coverage/assets/0.8.0/magnify.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-icons_222222_256x240.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-icons_2e83ff_256x240.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-icons_454545_256x240.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png",
+    "coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png",
+    "coverage/index.html",
+    "lib/nypl_collections.rb",
+    "lib/nypl_collections/client.rb",
+    "lib/nypl_collections/configuration.rb",
+    "nypl-collections.gemspec",
+    "spec/fixtures/return_captures_for_uuid.json",
+    "spec/nypl_collections/client_spec.rb",
+    "spec/nypl_collections/configuration_spec.rb",
+    "spec/nypl_collections_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/enspencer/nypl-collections"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.6"
+  s.summary = "A gem for interacting with the NYPL Digital Collections API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<dotenv>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<dotenv>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<dotenv>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/spec/fixtures/return_captures_for_uuid.json

@@ -0,0 +1 @@
+{"nyplAPI":{"request":{"uuid":"5fa75050-c6c7-012f-e24b-58d385a7bc34","perPage":"10","page":"1","totalPages":"13","startTime":"Beginning of Time","endTime":"Till Now"},"response":{"headers":{"status":"success","code":"200","message":"ok"},"numResults":"125","capture":[{"uuid":"510d47e3-6c3a-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582661","sortString":"0000000001|0000000001|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582661","title":"Title page.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c3b-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582662","sortString":"0000000001|0000000002|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582662","title":"Agnolo Gaddi, Louvre, 758. [The blessed virgin ascending steps of a temple.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c3c-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582663","sortString":"0000000001|0000000003|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582663","title":"Fra Angelico, British museum, 162. [The youthful David with a crown on his curly head, sitting on a settle, singing and playing on the psaltery.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c3d-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582664","sortString":"0000000001|0000000004|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582664","title":"Fra Angelico, Windsor, 163. [Bust of St. Lawrence.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c3e-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582665","sortString":"0000000001|0000000005|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582665","title":"Fra Angelico, Windsor, 163 verso. [St. Lawrence, a woman holding a child, and a youth with clasped hands.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c3f-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582666","sortString":"0000000001|0000000006|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582666","title":"Domenico di Michelino, Louvre, 1752. [Group of saints.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c40-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582667","sortString":"0000000001|0000000007|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582667","title":"Benozzo, Dresden, 532. [The full-length figure of St. Michael holding the hilt of a sword in his right hand, and a globe in his left..]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c41-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582668","sortString":"0000000001|0000000008|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582668","title":"Benozzo, British museum, 540. [The Madonna appearing to a girl saint, who sits up in her bed.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c42-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582669","sortString":"0000000001|0000000009|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582669","title":"Benozzo, Uffizi, 537. [A cardinal followed by an acolyte.]","dateDigitized":"2012-08-16T00:34:10Z"},{"uuid":"510d47e3-6c43-a3d9-e040-e00a18064a99","typeOfResource":"still image","imageID":"1582670","sortString":"0000000001|0000000010|0000000001","itemLink":"http://digitalgallery.nypl.org/nypldigital/id?1582670","title":"Benozzo, British museum, 542. [A bare-headed young man, in a cloak, pointing with his right hand as he walks.]","dateDigitized":"2012-08-16T00:34:10Z"}]}}}

data/spec/nypl_collections/client_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'pry'
+
+describe Collections::Client do
+  before do
+    @client = Collections::Client.new
+    @client.configure do |config|
+      config.auth_token = "abc123"
+    end
+  end
+
+  describe '#return_captures_for_uuid' do
+    before do
+      stub_request(:get, "http://api.repo.nypl.org/api/v1/items/5fa75050-c6c7-012f-e24b-58d385a7bc34?withTitles=yes&per_page=10").
+         with(:headers => {'Authorization'=>'Token token=abc123'}).
+         to_return(body: fixture('return_captures_for_uuid.json'))
+    end
+
+    it "fetches the first ten results" do
+      results = @client.return_captures_for_uuid('5fa75050-c6c7-012f-e24b-58d385a7bc34', withTitles: 'yes', per_page: '10')
+      results = JSON.parse(results.body)
+      expect(a_request(:get, "http://api.repo.nypl.org/api/v1/items/5fa75050-c6c7-012f-e24b-58d385a7bc34?withTitles=yes&per_page=10").
+         with(:headers => {'Authorization'=>'Token token=abc123'})).
+         to have_been_made
+      expect(results.first[1].first[1].first[1]).to eq "5fa75050-c6c7-012f-e24b-58d385a7bc34"
+    end
+  end
+
+end

data/spec/nypl_collections/configuration_spec.rb

@@ -0,0 +1 @@
+# Nothing needed here, already has full test coverage

data/spec/nypl_collections_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Collections do
+  describe '.new' do
+    it "returns a Collections::Client" do
+      expect(Collections.new).to be_a Collections::Client
+    end
+  end
+
+  describe ".configure" do
+    it "sets auth_token" do
+      Collections.configure do |config|
+        config.auth_token = "secret"
+      end
+
+      expect(Collections.auth_token).to eq "secret"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require './lib/nypl_collections'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+Coveralls.wear!

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: nypl-collections
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Emma Spencer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem for interacting with the NYPL Digital Collections API
+email: emma.n.spencer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- coverage/.last_run.json
+- coverage/.resultset.json
+- coverage/assets/0.8.0/application.css
+- coverage/assets/0.8.0/application.js
+- coverage/assets/0.8.0/colorbox/border.png
+- coverage/assets/0.8.0/colorbox/controls.png
+- coverage/assets/0.8.0/colorbox/loading.gif
+- coverage/assets/0.8.0/colorbox/loading_background.png
+- coverage/assets/0.8.0/favicon_green.png
+- coverage/assets/0.8.0/favicon_red.png
+- coverage/assets/0.8.0/favicon_yellow.png
+- coverage/assets/0.8.0/loading.gif
+- coverage/assets/0.8.0/magnify.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_222222_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_454545_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png
+- coverage/index.html
+- lib/nypl_collections.rb
+- lib/nypl_collections/client.rb
+- lib/nypl_collections/configuration.rb
+- nypl-collections.gemspec
+- spec/fixtures/return_captures_for_uuid.json
+- spec/nypl_collections/client_spec.rb
+- spec/nypl_collections/configuration_spec.rb
+- spec/nypl_collections_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/enspencer/nypl-collections
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A gem for interacting with the NYPL Digital Collections API
+test_files: []