ezid-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40cb3555f7bca7cbb5a29841afc004e9d00ebeaa
-  data.tar.gz: 07da9b35895929c94079f2ef82a24e511bb6f89a
+  metadata.gz: fbe64c4c33da9f4e797d596ea878a03b79757e23
+  data.tar.gz: 899e1b115a2d2be8c7958c6143c97e3d308df923
 SHA512:
-  metadata.gz: 6eb587dffe69c56bd119fcfbebcd06e58d3bc6cf4f7a5a5dcced275411b675e70ebebb0dcf1c19e21e4369b9673235d439860893be455c6e8d1b85f5de11284a
-  data.tar.gz: c29ec20b8fd8dae31c8e4e60afe0210c460b9817e6367c2284a9fe2045d43638705891dce0a148ad8ce8fc14e00ea70561ba878a963614d1c351e850cfaa0a82
+  metadata.gz: 5c720cbfa1e104e7b371b7374e9714a0a4b4a1a7e264d58ef49e85f74ce41c4b4e25a5c987965ffc0b6b6179adbbeffec5dc4b4124471ed243264d16ff2f85ca
+  data.tar.gz: b23da5c4d41d643e541683f799c830f979d68a212229ebdd3930bb9f6a65733a2ceecbcfaf28dd5c83d49bfe2b7eba086408dd0d5c17ac4cc41867556cbef7ef

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0.0
+cache: 
+  - bundler
+env: SPEC_OPTS="--tag ~type:feature"
+notifications:
+  email:
+    - lib-drs@duke.edu

data/README.md

@@ -16,73 +16,52 @@ Or install it yourself as:
 
     $ gem install ezid-client
 
-## Basic Usage
+## Resource-oriented Usage (CRUD)
 
-See `Ezid::Client` class for details.
+Create (Mint)
 
-**Create a client**
-
-```
->> client = Ezid::Client.new(user: "apitest")
-=> #<Ezid::Client:0x007f8ce651a890 , @user="apitest", @password="********">
-```
-
-Initialize with a block (wraps in a session)
-
-```
->> Ezid::Client.new(user: "apitest") do |client|
-?>   client.server_status("*")
->> end
-I, [2014-11-20T13:23:23.120797 #86059]  INFO -- : success: session cookie returned
-I, [2014-11-20T13:23:25.336596 #86059]  INFO -- : success: EZID is up
-I, [2014-11-20T13:23:25.804790 #86059]  INFO -- : success: authentication credentials flushed
-=> #<Ezid::Client:0x007faa5a6a9ee0 , @user="apitest", @password="********">
-```
-
-**Login**
-
-Note that login is not required to send authenticated requests; it merely establishes a session.  See http://ezid.cdlib.org/doc/apidoc.html#authentication.
-
-```
->> client.login
-I, [2014-11-20T13:10:50.958378 #85954]  INFO -- : success: session cookie returned
-=> #<Ezid::Client:0x007f8ce651a890 LOGGED_IN, @user="apitest", @password="********">
+```ruby
+>> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4")
+I, [2014-12-04T15:06:02.428445 #86655]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk4rx9d523
+I, [2014-12-04T15:06:03.249793 #86655]  INFO -- : EZID GET ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
+=> #<Ezid::Identifier id="ark:/99999/fk4rx9d523" status="public" target="http://ezid.cdlib.org/id/ark:/99999/fk4rx9d523" created="2014-12-04 20:06:02 UTC">
+>> identifier.id
+=> "ark:/99999/fk4rx9d523"
+>> identifier.status
+=> "public"
+>> identifier.target
+=> "http://ezid.cdlib.org/id/ark:/99999/fk4rx9d523"
 ```
 
-**Mint an identifier**
+Retrieve (Get)
 
-```
->> response = client.mint_identifier("ark:/99999/fk4")
-I, [2014-11-20T13:11:25.894128 #85954]  INFO -- : success: ark:/99999/fk4fn19h87
-=> #<Net::HTTPCreated 201 CREATED readbody=true>
->> response.identifier
-=> "ark:/99999/fk4fn19h87"
+```ruby
+>> identifier = Ezid::Identifier.find("ark:/99999/fk4rx9d523")
+I, [2014-12-04T15:07:00.648676 #86655]  INFO -- : EZID GET ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
+=> #<Ezid::Identifier id="ark:/99999/fk4rx9d523" status="public" target="http://ezid.cdlib.org/id/ark:/99999/fk4rx9d523" created="2014-12-04 20:06:02 UTC">
 ```
 
-**Get identifier metadata**
+Update (Modify)
 
-```
->> response = client.get_identifier_metadata(response.identifier)
-I, [2014-11-20T13:12:08.700287 #85954]  INFO -- : success: ark:/99999/fk4fn19h87
-=> #<Net::HTTPOK 200 OK readbody=true>
->> puts response.metadata
-_updated: 1416507086
-_target: http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87
-_profile: erc
-_ownergroup: apitest
-_owner: apitest
-_export: yes
-_created: 1416507086
-_status: public
-=> nil
+```ruby
+>> identifier.target = "http://example.com"
+=> "http://example.com"
+>> identifier.save
+I, [2014-12-04T15:11:57.263906 #86734]  INFO -- : EZID MODIFY ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
+I, [2014-12-04T15:11:58.099128 #86734]  INFO -- : EZID GET ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
+=> #<Ezid::Identifier id="ark:/99999/fk4rx9d523" status="public" target="http://example.com" created="2014-12-04 20:06:02 UTC">
 ```
 
-**Logout**
+Delete
 
-```
->> client.logout
-I, [2014-11-20T13:18:47.213566 #86059]  INFO -- : success: authentication credentials flushed
-=> #<Ezid::Client:0x007faa5a712350 , @user="apitest", @password="********">
+```ruby
+>> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4", status: "reserved")
+I, [2014-12-04T15:12:39.976930 #86734]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk4n58pc0r
+I, [2014-12-04T15:12:40.693256 #86734]  INFO -- : EZID GET ark:/99999/fk4n58pc0r -- success: ark:/99999/fk4n58pc0r
+=> #<Ezid::Identifier id="ark:/99999/fk4n58pc0r" status="reserved" target="http://ezid.cdlib.org/id/ark:/99999/fk4n58pc0r" created="2014-12-04 20:12:39 UTC">
+>> identifier.delete
+I, [2014-12-04T15:12:48.853964 #86734]  INFO -- : EZID DELETE ark:/99999/fk4n58pc0r -- success: ark:/99999/fk4n58pc0r
+=> #<Ezid::Identifier id="ark:/99999/fk4n58pc0r" DELETED>
 ```
 
 ## Metadata handling
@@ -104,7 +83,7 @@ Ezid::Client.configure do |config|
 end
 ```
 
-- At client initialization:
+- At client initialization (only if using Ezid::Client explicity):
 
 ```ruby
 client = Ezid::Client.new(user: "eziduser", password: "ezidpass")
@@ -112,9 +91,9 @@ client = Ezid::Client.new(user: "eziduser", password: "ezidpass")
 
 ## Running the tests
 
-By default the tests authenticate as user "apitest"; the password is not provided -- see http://ezid.cdlib.org/doc/apidoc.html#testing-the-api.
+See http://ezid.cdlib.org/doc/apidoc.html#testing-the-api.
 
-The test suite uses [VCR](https://relishapp.com/vcr/vcr) and [WebMock](https://github.com/bblimke/webmock) to stub requests and responses after the first run.  The VCR "cassettes" are written to `spec/cassettes` and may be cleared with the rake task `test:clean`.
+Integration tests have been tagged `type: :feature`.  In order to run those tests successfully, you must supply the password for the test account "apitest" (contact EZID).  You can exclude the integration tests with the RSpec option `--tag ~type:feature`.
 
 ## Contributing
 

data/Rakefile

@@ -4,11 +4,4 @@ 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

@@ -1 +1 @@
-0.3.0
+0.4.0

data/ezid-client.gemspec

@@ -17,9 +17,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 2.0"
+
+  spec.add_dependency "activesupport", "~> 4.0"
+
   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

@@ -1,11 +1,11 @@
-require_relative "api"
+require_relative "configuration"
 require_relative "request"
 require_relative "response"
-require_relative "metadata"
 require_relative "session"
-require_relative "configuration"
+require_relative "metadata"
+require_relative "identifier"
 require_relative "error"
-require_relative "logger"
+require_relative "status"
 
 module Ezid
   #
@@ -25,33 +25,9 @@ module Ezid
       def configure
         yield config
       end
-
-      # Creates an new identifier
-      # @see #create_identifier
-      def create_identifier(*args)
-        Client.new.create_identifier(*args)
-      end
-
-      # Mints a new identifier
-      # @see #mint_identifier
-      def mint_identifier(*args)
-        Client.new.mint_identifier(*args)
-      end
-      
-      # Retrieve the metadata for an identifier
-      # @see #get_identifier_metadata
-      def get_identifier_metadata(*args)
-        Client.new.get_identifier_metadata(*args)
-      end
-
-      # Logs into EZID
-      # @see #login
-      def login
-        Client.new.login
-      end
     end    
 
-    attr_reader :session, :user, :password
+    attr_reader :session, :user, :password # , :host
 
     def initialize(opts = {})
       @session = Session.new
@@ -65,10 +41,7 @@ module Ezid
     end
 
     def inspect
-      out = super
-      out.sub!(/@password="[^\"]+"/, "@password=\"********\"")
-      out.sub!(/@session=#<[^>]+>/, logged_in? ? "LOGGED_IN" : "")
-      out
+      "#<#{self.class.name} user=\"#{user}\" session=#{logged_in? ? 'OPEN' : 'CLOSED'}>"
     end
 
     # The client configuration
@@ -78,18 +51,23 @@ module Ezid
     end
 
     # The client logger
-    # @return [Ezid::Logger] the logger
+    # @return [Logger] the logger
     def logger
-      @logger ||= Ezid::Logger.new(config.logger)
+      @logger ||= config.logger
     end
 
     # Open a session
+    # @raise [Ezid::Error]
     # @return [Ezid::Client] the client
     def login
       if logged_in?
         logger.info("Already logged in, skipping login request.")
       else
-        do_login
+        response = Request.execute(:Get, "/login") do |request|
+          add_authentication(request)
+        end
+        handle_response(response, "LOGIN")
+        session.open(response.cookie)
       end
       self
     end
@@ -98,7 +76,9 @@ module Ezid
     # @return [Ezid::Client] the client
     def logout
       if logged_in?
-        do_logout
+        response = Request.execute(:Get, "/logout")
+        handle_response(response, "LOGOUT")
+        session.close
       else
         logger.info("Not logged in, skipping logout request.")
       end
@@ -112,104 +92,94 @@ module Ezid
 
     # @param identifier [String] the identifier string to create
     # @param metadata [String, Hash, Ezid::Metadata] optional metadata to set
+    # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def create_identifier(identifier, metadata=nil)
-      request = Request.new(:create_identifier, identifier)
-      add_authentication(request)
-      add_metadata(request, metadata)
-      execute(request)
+      response = Request.execute(:Put, "/id/#{identifier}") do |request|
+        add_authentication(request)
+        add_metadata(request, metadata)
+      end
+      handle_response(response, "CREATE #{identifier}")
     end
 
     # @param shoulder [String] the shoulder on which to mint a new identifier
     # @param metadata [String, Hash, Ezid::Metadata] metadata to set
+    # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def mint_identifier(shoulder, metadata=nil)
-      request = Request.new(:mint_identifier, shoulder)
-      add_authentication(request)
-      add_metadata(request, metadata)
-      execute(request)
+      raise Error, "Shoulder missing -- cannot mint identifier." unless shoulder
+      response = Request.execute(:Post, "/shoulder/#{shoulder}") do |request|
+        add_authentication(request)
+        add_metadata(request, metadata)
+      end
+      handle_response(response, "MINT #{shoulder}")
     end
     
     # @param identifier [String] the identifier to modify
     # @param metadata [String, Hash, Ezid::Metadata] metadata to set
+    # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def modify_identifier(identifier, metadata)
-      request = Request.new(:modify_identifier, identifier)
-      add_authentication(request)
-      add_metadata(request, metadata)
-      execute(request)
+      response = Request.execute(:Post, "/id/#{identifier}") do |request|
+        add_authentication(request)
+        add_metadata(request, metadata)
+      end
+      handle_response(response, "MODIFY #{identifier}")
     end
 
     # @param identifier [String] the identifier to retrieve
+    # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def get_identifier_metadata(identifier)
-      request = Request.new(:get_identifier_metadata, identifier)
-      add_authentication(request)
-      execute(request)
+      response = Request.execute(:Get, "/id/#{identifier}") do |request|
+        add_authentication(request)
+      end
+      handle_response(response, "GET #{identifier}")
     end
 
     # @param identifier [String] the identifier to delete
+    # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def delete_identifier(identifier)
-      request = Request.new(:delete_identifier, identifier)
-      add_authentication(request)
-      execute(request)
+      response = Request.execute(:Delete, "/id/#{identifier}") do |request|
+        add_authentication(request)
+      end
+      handle_response(response, "DELETE #{identifier}")
     end
 
     # @param subsystems [Array]
-    # @return [Ezid::Response] the response
+    # @raise [Ezid::Error]
+    # @return [Ezid::Status] the status response
     def server_status(*subsystems)
-      request = Request.new(:server_status, *subsystems)
-      execute(request)
+      response = Request.execute(:Get, "/status?subsystems=#{subsystems.join(',')}")
+      handle_response(Status.new(response), "STATUS")
     end
 
     private
 
-    def build_request(*args)
-      request = Request.new(*args)
-    end
-
-    # Executes the request
-    # @param request [Ezid::Request] the request
-    # @raise [Ezid::Error] if the response status indicates an error
-    # @return [Ezid::Response] the response
-    def execute(request)
-      response = Response.new(request.execute)
-      logger.request_and_response(request, response)
-      raise Error, response.message if response.error?
-      response
-    end
-
-    # Adds metadata to the request
-    def add_metadata(request, metadata)
-      return if metadata.nil? || metadata.empty?
-      metadata = Metadata.new(metadata) # copy/coerce
-      request.add_metadata(metadata) 
-    end
-
-    # Adds authentication to the request
-    def add_authentication(request)
-      if session.open?
-        request.add_authentication(cookie: session.cookie)
-      else
-        request.add_authentication(user: user, password: password)
+      # Adds authentication data to the request
+      def add_authentication(request)
+        if session.open?
+          request["Cookie"] = session.cookie
+        else
+          request.basic_auth(user, password)
+        end
       end
-    end
 
-    # Does the login
-    def do_login
-      request = Request.new(:login)
-      add_authentication(request)
-      response = execute(request)
-      session.open(response)
-    end
+      # Adds EZID metadata (if any) to the request body
+      def add_metadata(request, metadata)
+        return if metadata.nil? || metadata.empty?
+        metadata = Metadata.new(metadata) unless metadata.is_a?(Metadata)
+        request.body = metadata.to_anvl(false) 
+      end
 
-    # Does the logoug
-    def do_logout
-      request = Request.new(:logout)
-      execute(request)
-      session.close
-    end
+      def handle_response(response, request_info)
+        log_level = response.error? ? Logger::ERROR : Logger::INFO
+        message = "EZID #{request_info} -- #{response.status_line}"
+        logger.log(log_level, message)
+        raise response.exception if response.exception
+        response
+      end
 
   end
 end

data/lib/ezid/configuration.rb

@@ -9,28 +9,43 @@ module Ezid
   # @api private
   class Configuration
 
-    attr_writer :user, :password, :logger
+    # EZID user name
+    #   Default: value of EZID_USER environment variable
+    attr_accessor :user
 
-    # Default metadata profile (recommended)
-    attr_accessor :default_metadata_profile
+    # EZID password
+    #   Default: value of EZID_PASSWORD environment variable
+    attr_accessor :password
+
+    # Ruby logger instance
+    #   Default device: STDERR
+    attr_writer :logger
+
+    # Default metadata profile
+    # attr_accessor :default_metadata_profile
 
     # Default status - set only if default should not "public" (EZID default)
-    attr_accessor :default_status
+    # attr_accessor :default_status
 
-    # Default shoulder for minting (recommended)
-    attr_accessor :default_shoulder
+    # Default shoulder for minting
+    # attr_accessor :default_shoulder
 
-    def user
-      @user ||= ENV["EZID_USER"]
-    end
+    # Hash of options to pass to Net::HTTP.start
+    # attr_accessor :http_request_options
 
-    def password
-      @password ||= ENV["EZID_PASSWORD"]
+    def initialize
+      @user = ENV["EZID_USER"]
+      @password = ENV["EZID_PASSWORD"]
+      # @http_request_options = default_http_request_options
     end
 
     def logger
-      @logger ||= ::Logger.new(STDERR)
+      @logger ||= Logger.new(STDERR)
     end
 
+    # def default_http_request_options
+    #   { use_ssl: true }
+    # end
+
   end
 end