ezid-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c103eaae29bd61679e4e349a5a14ab7964edd291
+  data.tar.gz: 047f1df3708982722bcbad3fac050183cf6285a6
+SHA512:
+  metadata.gz: 53b9aa4362dbeea70ad165b6977756b63ac0ca6ad970fae98caa11ba135e83603f102b23de54b27577a38293f3701bf89712bdc60e7fd19409de0dc1f9a2ea73
+  data.tar.gz: ac9b5fa24406b489ce716d6683d2d68c2d6c7e01d59da813e1848385f811ce3d9f4158e6e3b8649935c216624fb273742097bf639d181af7c8a5c04a828cff61

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/cassettes
+spec/reports
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ezid-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) Duke University Libraries.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright notice,
+       this list of conditions and the following disclaimer in the documentation
+       and/or other materials provided with the distribution.
+
+    3. Neither the name of Duke University nor the names of its contributors may
+       be used to endorse or promote products derived from this software without
+       specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,71 @@
+# Ezid::Client
+
+EZID API Version 2 bindings. See http://ezid.cdlib.org/doc/apidoc.html.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ezid-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ezid-client
+
+## Usage
+
+Create a client
+
+```ruby
+>> client = Ezid::Client.new(user: "apitest", password: "********")
+=> #<Ezid::Client:0x007f857c23ca40 @user="apitest", @password="********", @session=#<Ezid::Session:0x007f857c2515a8 @cookie="sessionid=quyclw5bbnwsay0qh05isalt86xj5o1l">>
+```
+
+Mint an identifier
+
+```ruby
+>> response = client.mint_identifier("ark:/99999/fk4")
+=> #<Ezid::Response:0x007f857c488010 @http_response=#<Net::HTTPCreated 201 CREATED readbody=true>, @metadata=#<Ezid::Metadata:0x007f857c488448 @elements={}>, @result="success", @message="ark:/99999/fk4988cc8j">
+>> response.identifier
+=> "ark:/99999/fk4988cc8j"
+```
+
+Modify identifier metadata
+
+```ruby
+>> metadata = Ezid::Metadata.new("dc.type" => "Image")
+=> #<Ezid::Metadata:0x007f857c251c88 @elements={"dc.type"=>"Image"}>
+>> response = client.modify_identifier("ark:/99999/fk4988cc8j", metadata)
+=> #<Ezid::Response:0x007f857c53ab20 @http_response=#<Net::HTTPOK 200 OK readbody=true>, @metadata=#<Ezid::Metadata:0x007f857c53aa30 @elements={}>, @result="success", @message="ark:/99999/fk4988cc8j">
+```
+
+Get identifier metadata
+
+```
+>> response = client.get_identifier_metadata("ark:/99999/fk4988cc8j")
+=> #<Ezid::Response:0x007f857c50a060 @http_response=#<Net::HTTPOK 200 OK readbody=true>, @metadata=#<Ezid::Metadata:0x007f857c509f48 @elements={"_updated"=>"1416436386", "_target"=>"http://ezid.cdlib.org/id/ark:/99999/fk4988cc8j", "_profile"=>"erc", "dc.type"=>"Image", "_ownergroup"=>"apitest", "_owner"=>"apitest", "_export"=>"yes", "_created"=>"1416436287", "_status"=>"public"}>, @result="success", @message="ark:/99999/fk4988cc8j">
+>> response.metadata["dc.type"]
+=> "Image"
+>> puts response.metadata
+_updated: 1416436386
+_target: http://ezid.cdlib.org/id/ark:/99999/fk4988cc8j
+_profile: erc
+dc.type: Image
+_ownergroup: apitest
+_owner: apitest
+_export: yes
+_created: 1416436287
+_status: public
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ezid-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :test do
+  desc "Clean up test artifacts (e.g., VCR cassettes)"
+  task :clean do
+    FileUtils.rm_rf File.join(__dir__, "spec", "cassettes")
+  end
+end
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ezid-client.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ezid-client"
+  spec.version       = File.read(File.expand_path("../VERSION", __FILE__)).chomp
+  spec.authors       = ["dchandekstark"]
+  spec.email         = ["dchandekstark@gmail.com"]
+  spec.summary       = "Ruby client for EZID API Version 2"
+  spec.description   = "Ruby client for EZID API Version 2 (http://ezid.cdlib.org/doc/apidoc.html)"
+  spec.homepage      = "https://github.com/duke-libraries/ezid-client"
+  spec.license       = "BSD-3-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/lib/ezid-client.rb

@@ -0,0 +1 @@
+require "ezid/client"

data/lib/ezid/api.rb

@@ -0,0 +1,52 @@
+module Ezid
+  #
+  # EZID API Version 2 bindings
+  #
+  module Api
+
+    VERSION = "2"
+
+    # EZID server subsystems
+    DATACITE_SUBSYSTEM = "datacite"
+    NOID_SUBSYSTEM = "noid"
+    LDAP_SUBSYSTEM = "ldap"
+    ALL_SUBSYSTEMS = "*"
+
+    class << self
+
+      def login
+        [:Get, "/login"]
+      end
+
+      def logout
+        [:Get, "/logout"]
+      end
+
+      def mint_identifier(shoulder)
+        [:Post, "/shoulder/#{shoulder}"]
+      end
+
+      def create_identifier(identifier)
+        [:Put, "/id/#{identifier}"]
+      end
+
+      def modify_identifier(identifier)
+        [:Post, "/id/#{identifier}"]
+      end
+
+      def get_identifier_metadata(identifier)
+        [:Get, "/id/#{identifier}"]
+      end
+
+      def delete_identifier(identifier)
+        [:Delete, "/id/#{identifier}"]
+      end
+
+      def server_status(subsystems)
+        [:Get, "/status", "subsystems=#{subsystems.join(',')}"]
+      end
+
+    end
+
+  end
+end

data/lib/ezid/client.rb

@@ -0,0 +1,184 @@
+require_relative "identifier"
+require_relative "request"
+require_relative "session"
+require_relative "configuration"
+require_relative "error"
+
+module Ezid
+  class Client
+
+    class << self
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      def create_identifier(*args)
+        Client.new.create_identifier(*args)
+      end
+
+      def mint_identifier(*args)
+        Client.new.mint_identifier(*args)
+      end
+
+      def get_identifier_metadata(*args)
+        Client.new.get_identifier_metadata(*args)
+      end
+
+      def login
+        Client.new.login
+      end
+    end    
+
+    attr_reader :session, :user, :password
+
+    def initialize(opts = {})
+      @session = Session.new
+      @user = opts[:user] || config.user
+      @password = opts[:password] || config.password
+      if block_given?
+        login
+        yield self
+        logout
+      end
+    end
+
+    def inspect
+      out = super
+      out.sub!(/@password="[^\"]+"/, "@password=\"********\"")
+      out.sub!(/@session=#<[^>]+>/, logged_in? ? "LOGGED_IN" : "")
+      out
+    end
+
+    def config
+      self.class.config
+    end
+
+    def logger
+      config.logger
+    end
+
+    def login
+      if logged_in?
+        logger.info("Already logged in, skipping login request.")
+      else
+        do_login
+      end
+    end
+
+    def logout
+      if logged_in?
+        do_logout
+      else
+        logger.info("Not logged in, skipping logout request.")
+      end
+    end
+
+    def logged_in?
+      session.open?
+    end
+
+    def create_identifier(identifier, metadata=nil)
+      request = Request.build(:create_identifier, identifier)
+      add_authentication(request)
+      add_metadata(request, metadata)
+      execute(request)
+    end
+
+    def mint_identifier(shoulder, metadata=nil)
+      request = Request.build(:mint_identifier, shoulder)
+      add_authentication(request)
+      add_metadata(request, metadata)
+      execute(request)
+    end
+    
+    def modify_identifier(identifier, metadata)
+      raise ArgumentError, "Metadata is required" if metadata.nil? || metadata.empty?
+      request = Request.build(:modify_identifier, identifier)
+      add_authentication(request)
+      add_metadata(request, metadata)
+      execute(request)
+    end
+
+    def get_identifier_metadata(identifier)
+      request = Request.build(:get_identifier_metadata, identifier)
+      add_authentication(request)
+      execute(request)
+    end
+
+    def delete_identifier(identifier)
+      request = Request.build(:delete_identifier, identifier)
+      add_authentication(request)
+      execute(request)
+    end
+
+    def server_status(*subsystems)
+      request = Request.build(:server_status, subsystems)
+      execute(request)
+    end
+
+    private
+
+    # Executes the request
+    def execute(request)
+      response = request.execute
+      handle_response(response)
+    end
+
+    # Handles the response
+    def handle_response(response)
+      raise Error, response.message if response.error?
+      response
+    ensure
+      log_response(response)
+    end
+
+    # Logs a message for the response
+    def log_response(response)
+      logger.log(log_level(response), log_message(response))
+    end
+
+    # Returns the log level to use for the response
+    def log_level(response)
+      response.error? ? Logger::ERROR : Logger::INFO
+    end
+
+    # Returns the message to log for the response
+    def log_message(response)
+      response.status_line
+    end
+
+    # Adds metadata to the request
+    def add_metadata(request, metadata)
+      request.body = metadata.to_anvl unless metadata.nil? || metadata.empty?
+    end
+
+    # Adds authentication to the request
+    def add_authentication(request)
+      if session.open?
+        request["Cookie"] = session.cookie 
+      else
+        request.basic_auth(user, password)
+      end
+    end
+
+    def do_login
+      request = Request.build(:login)
+      add_authentication(request)
+      response = execute(request)
+      session.open(response)
+      self
+    end
+
+    def do_logout
+      request = Request.build(:logout)
+      execute(request)
+      session.close
+      self
+    end
+
+  end
+end

data/lib/ezid/configuration.rb

@@ -0,0 +1,22 @@
+require "logger"
+
+module Ezid
+  class Configuration
+
+    attr_writer :user, :password, :logger
+    attr_accessor :metadata_profile, :default_status
+
+    def user
+      @user ||= ENV["EZID_USER"]
+    end
+
+    def password
+      @password ||= ENV["EZID_PASSWORD"]
+    end
+
+    def logger
+      @logger ||= Logger.new(STDERR)
+    end
+
+  end
+end

data/lib/ezid/error.rb

@@ -0,0 +1,3 @@
+module Ezid
+  class Error < ::RuntimeError; end
+end

data/lib/ezid/identifier.rb

@@ -0,0 +1,56 @@
+require_relative "metadata"
+
+module Ezid
+  class Identifier
+
+    class << self
+      def create(id, metadata=nil)
+        response = Client.create_identifier(id, metadata)
+        Identifier.new(response.identifier)
+      end
+
+      def mint(metadata=nil)
+        response = Client.mint_identifier(metadata)
+        identifier = Identifier.new(response.identifier)
+      end
+
+      def find(id)
+        response = Client.get_identifier_metadata(id)
+        Identifier.new(response.identifier, response.metadata)
+      end
+    end
+
+    attr_reader :id
+
+    def initialize(id, metadata=nil)
+      @id = id
+      @metadata = Metadata.new(metadata)
+    end
+
+    def metadata
+      reload if @metadata.empty?
+      @metadata
+    end
+
+    def reload
+      response = client.get_identifier_metadata(id)
+      @metadata.update(response.metadata)
+      self
+    end
+
+    def client
+      @client ||= Client.new
+    end
+
+    def save
+      response = client.modify_identifier(id, metadata)
+      response.success?
+    end
+
+    def delete
+      response = client.delete_identifier(id)
+      response.success?
+    end
+
+  end
+end

data/lib/ezid/metadata.rb

@@ -0,0 +1,79 @@
+require "forwardable"
+
+module Ezid
+  class Metadata
+    extend Forwardable
+
+    attr_reader :elements
+    def_delegators :elements, :[], :[]=, :empty?, :to_h, :to_a
+
+    ERC_PROFILE = "erc"
+    DC_PROFILE = "dc"
+    DATACITE_PROFILE = "datacite"
+    CROSSREF_PROFILE = "crossref"
+
+    STATUS_PUBLIC = "public"
+    STATUS_RESERVED = "reserved"
+    STATUS_UNAVAILABLE = "unavailable"
+
+    # Internal metadata elements
+    INTERNAL_READONLY_ELEMENTS = %w( _owner _ownergroup _created _updated _shadows _shadowedby _datacenter ).freeze
+    INTERNAL_READWRITE_ELEMENTS = %w( _coowners _target _profile _status _export _crossref ).freeze        
+    INTERNAL_ELEMENTS = (INTERNAL_READONLY_ELEMENTS + INTERNAL_READWRITE_ELEMENTS).freeze
+    
+    ANVL_SEPARATOR = ": ".freeze
+
+    # Creates a reader method for each internal metadata element
+    INTERNAL_ELEMENTS.each do |element|
+      reader = element.sub("_", "").to_sym
+      define_method(reader) do
+        self[element]
+      end
+    end
+
+    # Creates a writer method for each writable internal metadata element
+    INTERNAL_READWRITE_ELEMENTS.each do |element|
+      writer = "#{element.sub('_', '')}=".to_sym
+      define_method(writer) do |value|
+        self[element] = value
+      end
+    end
+
+    # @param data [Hash, String, Ezid::Metadata] EZID metadata
+    def initialize(data={})
+      @elements = coerce(data)
+    end
+
+    # @todo escape \n, \r and %
+    # @todo force UTF-8
+    # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
+    def to_anvl
+      to_a.map { |pair| pair.join(ANVL_SEPARATOR) }.join("\n")
+    end
+
+    def to_s
+      to_anvl
+    end
+
+    # Add metadata
+    def update(data)
+      elements.update(coerce(data))
+    end
+
+    private
+
+    # Coerce data into a Hash of elements
+    # @todo unescape 
+    # @see {#to_anvl}
+    def coerce(data)
+      begin
+        data.to_h
+      rescue NoMethodError
+        # This does not account for comments and continuation lines
+        # http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
+        data.split(/\r?\n/).map { |line| line.split(ANVL_SEPARATOR, 2) }.to_h
+      end
+    end
+
+  end
+end

data/lib/ezid/request.rb

@@ -0,0 +1,34 @@
+require "uri"
+require "net/http"
+require "delegate"
+
+require_relative "api"
+require_relative "response"
+
+module Ezid
+  #
+  # A request to the EZID service.
+  #
+  class Request < SimpleDelegator
+
+    EZID_HOST = "ezid.cdlib.org"
+    CHARSET = "UTF-8"
+    CONTENT_TYPE = "text/plain"
+
+    def self.build(op, *args)
+      http_method, path, query = Api.send(op, *args)
+      uri = URI::HTTPS.build(host: EZID_HOST, path: path, query: query)
+      http_request = Net::HTTP.const_get(http_method).new(uri)
+      Request.new(http_request)
+    end
+
+    def execute
+      http_response = Net::HTTP.start(uri.host, use_ssl: true) do |http|
+        set_content_type(CONTENT_TYPE, charset: CHARSET)
+        http.request(__getobj__)
+      end
+      Response.build(http_response)
+    end
+
+  end
+end

data/lib/ezid/response.rb

@@ -0,0 +1,59 @@
+require "delegate"
+
+module Ezid
+  # A response from the EZID service.
+  class Response < SimpleDelegator
+
+    SUCCESS = "success"
+    ERROR = "error"
+
+    def self.build(http_response)
+      Response.new(http_response)
+    end
+
+    def status
+      @status ||= status_line.split(/: /)
+    end
+
+    def status_line
+      content.first
+    end
+
+    def content
+      @content ||= body.split(/\r?\n/, 2)
+    end
+
+    def metadata
+      content.last if success? && identifier_uri?
+    end
+
+    def identifier
+      message.split(/\s/).first if success? && identifier_uri?
+    end
+
+    def identifier_uri?
+      uri.path =~ /^\/(id|shoulder)\//
+    end
+
+    def outcome
+      status.first
+    end
+
+    def message
+      status.last
+    end
+
+    def cookie
+      self["Set-Cookie"].split(";").first rescue nil
+    end
+
+    def error?
+      outcome == ERROR
+    end
+
+    def success?
+      outcome == SUCCESS
+    end
+
+  end
+end

data/lib/ezid/session.rb

@@ -0,0 +1,37 @@
+require "uri"
+require "net/http"
+
+require_relative "request"
+
+module Ezid
+  class Session
+
+    attr_reader :cookie
+
+    def initialize(response=nil)
+      open(response) if response
+    end
+
+    def inspect
+      super.sub(/@cookie="[^\"]+"/, "OPEN")
+    end
+
+    def open(response)
+      # XXX raise exception if no cookie?
+      @cookie = response.cookie if response.cookie
+    end
+
+    def close
+      @cookie = nil
+    end
+
+    def closed?
+      cookie.nil?
+    end
+    
+    def open?
+      !closed?
+    end
+
+  end
+end

data/lib/ezid/test_helper.rb

@@ -0,0 +1,17 @@
+module Ezid
+  module TestHelper
+    
+    TEST_USER = "apitest"
+    ARK_SHOULDER = "ark:/99999/fk4"
+    DOI_SHOULDER = "doi:10.5072/FK2"
+
+    def doi_metadata
+      Metadata.new("datacite.title" => "Test", 
+                   "datacite.creator" => "Duke",
+                   "datacite.publisher" => "Duke",
+                   "datacite.publicationyear" => "2014",
+                   "datacite.resourcetype" => "Other")
+    end
+
+  end
+end

data/spec/lib/ezid/client_spec.rb

@@ -0,0 +1,80 @@
+module Ezid
+  RSpec.describe Client do
+    describe "initialization" do
+      describe "without a block" do
+        subject { described_class.new(user: TEST_USER) }
+        it "should not be logged in" do
+          expect(subject).not_to be_logged_in
+        end
+      end
+      describe "with a block", :vcr do
+        it "should be logged in" do
+          described_class.new(user: TEST_USER) do |client|
+            expect(client).to be_logged_in
+          end
+        end
+      end
+    end
+    
+    describe "authentication", :vcr do
+      subject { described_class.new(user: TEST_USER) }
+      describe "logging in" do
+        before { subject.login }
+        it "should be logged in" do
+          expect(subject).to be_logged_in
+        end
+      end
+      describe "logging out" do
+        before { subject.login; subject.logout }
+        it "should not be logged in" do
+          expect(subject).not_to be_logged_in
+        end
+      end
+    end
+    describe "creating an identifier" do
+      # TODO
+    end
+    describe "minting an identifier", :vcr do
+      let(:client) { described_class.new(user: TEST_USER) }
+      describe "which is an ARK" do
+        subject { client.mint_identifier(ARK_SHOULDER) }
+        it "should be a success" do
+          expect(subject).to be_success
+          expect(subject.message).to match(/#{ARK_SHOULDER}/)
+        end
+      end
+      describe "which is a DOI" do
+        subject { client.mint_identifier(DOI_SHOULDER, doi_metadata) }
+        it "should be a sucess" do
+          expect(subject).to be_success
+          expect(subject.message).to match(/#{DOI_SHOULDER}/)
+          expect(subject.message).to match(/\| ark:/)
+        end
+      end
+    end
+    describe "getting identifier metadata", :vcr do
+      let(:client) { described_class.new(user: TEST_USER) }
+      let(:metadata) { Metadata.new("dc.title" => "Test") }
+      let(:identifier) { client.mint_identifier(ARK_SHOULDER, metadata).message }
+      subject { Metadata.new(client.get_identifier_metadata(identifier).content.last) }
+      it "should return the metadata" do
+        expect(subject["dc.title"]).to eq("Test")
+      end
+    end
+    describe "modifying an identifier" do
+      # TODO
+    end
+    describe "deleting an identifier" do
+      # TODO
+    end
+    describe "server status", :vcr do
+      let(:client) { described_class.new(user: TEST_USER) }
+      subject { client.server_status("*") }
+      it "should report the status of EZID and subsystems" do
+        expect(subject).to be_success
+        expect(subject.message).to eq "EZID is up"        
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "ezid-client"
+require "ezid/test_helper"
+
+include Ezid::TestHelper
+
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.allow_http_connections_when_no_cassette = true
+end
+
+RSpec.configure do |config|
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: ezid-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dchandekstark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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: Ruby client for EZID API Version 2 (http://ezid.cdlib.org/doc/apidoc.html)
+email:
+- dchandekstark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- ezid-client.gemspec
+- lib/ezid-client.rb
+- lib/ezid/api.rb
+- lib/ezid/client.rb
+- lib/ezid/configuration.rb
+- lib/ezid/error.rb
+- lib/ezid/identifier.rb
+- lib/ezid/metadata.rb
+- lib/ezid/request.rb
+- lib/ezid/response.rb
+- lib/ezid/session.rb
+- lib/ezid/test_helper.rb
+- spec/lib/ezid/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/duke-libraries/ezid-client
+licenses:
+- BSD-3-Clause
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for EZID API Version 2
+test_files:
+- spec/lib/ezid/client_spec.rb
+- spec/spec_helper.rb