montague 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5226c19f5fadffaa16d55605546efceb1a8c20ad
+  data.tar.gz: e17f0ad06b2dee8460b17c30d15209ec2d35d611
+SHA512:
+  metadata.gz: fbc04e1e3037e14f53f481c9e8cfacbe99daeb03282e2d3731fc7df6269bec12ebd7498e126d5e2d05408f857d90be9a60f20348ee1374990cddbaec1cb32d14
+  data.tar.gz: 88e6fc0cd58ad35adb326549b84ad34faf2c0b3834cc001a4f03d09b3f22497a830adff0b34df30bcf875d32712c6498c9c6637d03537cb6619c8599cf38bbbf

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.2.0 - 2018-02-09
+### Removed
+- Language support.
+
+## 0.1.1 - 2018-02-07
+### Changed
+- Language support - string keyword argument replaced by symbol.
+
+## 0.1.0 - 2018-02-06
+### Added
+- For SHERPA/RoMEO API v2.9.
+- Find publisher indirectly using journal search by ISSN, search by title.
+- Find publisher directly using publisher search by name, search by ID.

data/Gemfile

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

data/README.md

@@ -0,0 +1,138 @@
+# Montague
+
+Wrapper for the SHERPA/RoMEO API.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/montague.svg)](https://badge.fury.io/rb/montague)
+[![Maintainability](https://api.codeclimate.com/v1/badges/73f9d8be3f61882a8ec6/maintainability)](https://codeclimate.com/github/lulibrary/montague/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'montague'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install montague
+
+## Usage
+
+Discover a publisher's copyright and archiving policies by searching for a publisher directly or by searching for a publisher indirectly via a journal.
+
+<a href="http://www.sherpa.ac.uk/romeo.php"><img src="http://www.sherpa.ac.uk/images/romeosmall.jpg" width="100" height="54" alt="SHERPA/RoMEO Database" border="0"></a>
+
+### Journal search
+```ruby
+# without API key
+journals = Montague::API::Journal.new
+# with API key
+journals = Montague::API::Journal.new api_key: 'YOUR_API_KEY'
+```
+
+#### Find by journal ISSN
+
+```ruby
+report = journals.find_by_issn '1550-7998'
+#=> #<Montague::Model::JournalReport:0x00c0ffee ...>
+report.journal
+#=> #<Montague::Model::Journal:0x00c0ffee @title="Physical Review D - Particles, Fields, Gravitation and Cosmology", @issn="1550-7998">
+report.publisher
+#=> #<Montague::Model::Publisher:0x00c0ffee ...>
+report.publisher.name
+#=> "American Physical Society"
+report.publisher.conditions
+#=> ["On author's personal website, employer's website or institutional repository", ...]
+report.publisher.pre_prints
+#=> #<Montague::Model::Archiving:0x00c0ffee @permission="can", @restrictions=[]>
+report.publisher.romeo_colour
+#=> "green"
+report.publisher.mandates
+#=> [#<Montague::Model::Mandate:0x00c0ffee @funder=#<Montague::Model::Funder:0x00c0ffee @name="Australian Research Council", @acronym="ARC">, @publisher_complies="yes", @compliance_type="Compliant", @selected_titles="no">, ...]
+```
+
+```ruby
+# alternative numbers for a journal, typically ESSN and ISSN
+report = journals.find_by_issn '1552-3535,0013-1245'
+report.journal
+#=> #<Montague::Model::Journal:0xb3969e8 @title="Education and Urban Society", @issn="0013-1245">
+report.publisher
+#=> #<Montague::Model::Publisher:0x00c0ffee ...>
+```
+
+#### Find by journal title
+```ruby
+report = journals.find_by_title text: 'modern language', filter: :contains
+#=> #<Montague::Model::JournalsReport:0x00c0ffee ...>
+report.journals.size
+#=> 13
+report.journals
+#=> [#<Montague::Model::Journal:0xacf4aa4 @title="Canadian Modern Language Review / Revue canadian des langues vivantes", @issn="0008-4506">, ...]
+report.publisher
+#=> nil
+```
+
+```ruby
+# example of when the publisher is not available for a journal
+report = journals.find_by_title text: 'Man', filter: :exact
+#=> #<Montague::Model::JournalsReport:0x00c0ffee ...>
+report.journals.size
+#=> 1
+report.publisher
+#=> nil
+```
+
+### Publisher search
+```ruby
+# without API key
+publishers = Montague::API::Publisher.new
+# with API key
+publishers = Montague::API::Publisher.new api_key: 'YOUR_API_KEY'
+```
+
+#### Find by publisher name
+```ruby
+report = publishers.find_by_name text: 'institute', filter: :exact
+#=> #<Montague::Model::PublishersReport:0x00c0ffee ...>
+report.publishers.size
+#=> 122
+```
+
+#### Find by publisher ID (RoMEO)
+```ruby
+report = publishers.find_by_id 10
+#=> #<Montague::Model::PublisherReport:0x00c0ffee ...>
+report.publisher
+#=> #<Montague::Model::Publisher:0x00c0ffee ...>
+```
+
+### Search client
+```ruby
+# without API key
+client = Montague::API::Client.new
+# with API key
+client = Montague::API::Client.new api_key: 'YOUR_API_KEY'
+```
+
+```ruby
+report = client.journals.find_by_issn '1550-7998'
+#=> #<Montague::Model::JournalReport:0x00c0ffee ...>
+report.publisher
+#=> #<Montague::Model::Publisher:0x00c0ffee ...>
+```
+
+### Inspecting reports
+```ruby
+report.header
+#=> #<Montague::Model::Header:0x00c0ffee @api_control="journal", @hits=1, @message=nil, @outcome="singleJournal">
+report.http_response
+#=> #<HTTP::Response/1.1 200 OK {"Date"=>"Fri, 02 Feb 2018 11:34:38 GMT", "Server"=>"Apache/2.4.7 (Ubuntu)", "X-Powered-By"=>"PHP/5.5.9-1ubuntu4.22", "Access-Control-Allow-Origin"=>"*", "Vary"=>"Accept-Encoding", "Content-Length"=>"5056", "Connection"=>"close", "Content-Type"=>"text/xml"}>
+```
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/montague.rb

@@ -0,0 +1,9 @@
+require 'montague/api/api'
+require 'montague/model/model'
+require 'montague/reporter/reporter'
+require 'montague/xml_extractor/xml_extractor'
+
+# Wrapper for the SHERPA/RoMEO API
+#
+module Montague
+end

data/lib/montague/api/api.rb

@@ -0,0 +1,12 @@
+require 'http'
+require 'montague/api/base'
+require 'montague/api/journal'
+require 'montague/api/publisher'
+require 'montague/api/client'
+
+module Montague
+  # Requests for a resource
+  #
+  module API
+  end
+end

data/lib/montague/api/base.rb

@@ -0,0 +1,27 @@
+module Montague
+
+  module API
+
+    # Base API
+    #
+    class Base
+
+      # @param config [Hash]
+      # @option config [String] :api_url URL of the SHERPA/RoMEO service (if it changes)
+      # @option config [String] :api_key API key of the SHERPA/RoMEO service user
+      def initialize(config = {})
+        @config = config
+        @config[:api_url] = 'http://www.sherpa.ac.uk/romeo/api29.php' unless config[:api_url]
+      end
+
+      private
+
+      def common_parameters
+        "&showfunder=all&ak=#{@config[:api_key]}"
+      end
+
+    end
+
+  end
+
+end

data/lib/montague/api/client.rb

@@ -0,0 +1,27 @@
+module Montague
+
+  module API
+
+    # API client
+    #
+    class Client < Montague::API::Base
+      # (see Montague::API::Base#initialize)
+      def initialize(config = {})
+        super
+      end
+
+      # @return [Montague::API::Journal]
+      def journals
+        Montague::API::Journal.new @config
+      end
+
+      # @return [Montague::API::Publisher]
+      def publishers
+        Montague::API::Publisher.new @config
+      end
+
+    end
+
+  end
+
+end

data/lib/montague/api/journal.rb

@@ -0,0 +1,52 @@
+module Montague
+
+  module API
+
+    # Journal API
+    #
+    class Journal < Montague::API::Base
+
+      # (see Montague::API::Base#initialize)
+      def initialize(config = {})
+        super
+      end
+
+      # @param issn [String] International Standard Serial Number e.g. 1234-5678.
+      # @return (see #journal_report)
+      def find_by_issn(issn)
+        url = "#{@config[:api_url]}?issn=#{issn}#{common_parameters}"
+        response = HTTP.get URI.encode(url)
+        journal_report response
+      end
+
+      # @param text [String] Multiple words treated as a single string. Case insensitive.
+      # @param filter [Symbol]
+      #   * :exact - Verbatim e.g. 'Journal of Geology'
+      #   * :starts - Starts with e.g. 'machine'
+      #   * :contains - Contains e.g. 'modern language'
+      # @return (see #journals_report)
+      def find_by_title(text:, filter: :exact)
+        url = "#{@config[:api_url]}?jtitle=#{text}&qtype=#{filter}#{common_parameters}"
+        response = HTTP.get URI.encode(url)
+        journals_report response
+      end
+
+      private
+
+      # @return [Montague::Model::JournalReport]
+      def journal_report(response)
+        reporter = Montague::Reporter::Journal.new response
+        reporter.report
+      end
+
+      # @return [Montague::Model::JournalsReport]
+      def journals_report(response)
+        reporter = Montague::Reporter::Journals.new response
+        reporter.report
+      end
+
+    end
+
+  end
+
+end

data/lib/montague/api/publisher.rb

@@ -0,0 +1,52 @@
+module Montague
+
+  module API
+
+    # Publisher API
+    #
+    class Publisher < Montague::API::Base
+
+      # (see Montague::API::Base#initialize)
+      def initialize(config = {})
+        super
+      end
+
+      # @param id [Fixnum] RoMEO persistent ID
+      # @return (see #publisher_report)
+      def find_by_id(id)
+        url = "#{@config[:api_url]}?id=#{id}#{common_parameters}"
+        response = HTTP.get URI.encode(url)
+        publisher_report response
+      end
+
+      # @param text [String] e.g. 'optical society'
+      # @param filter [Symbol]
+      #   * :all - All words present but in any order or location
+      #   * :any - At least one of the words present
+      #   * :exact - Intact phrase somewhere e.g. 'tute of'
+      # @return (see #publishers_report)
+      def find_by_name(text:, filter: :all)
+        url = "#{@config[:api_url]}?pub=#{text}&qtype=#{filter}#{common_parameters}"
+        response = HTTP.get URI.encode(url)
+        publishers_report response
+      end
+
+      private
+
+      # @return [Montague::Model::PublishersReport]
+      def publishers_report(response)
+        reporter = Montague::Reporter::Publishers.new response
+        reporter.report
+      end
+
+      # @return [Montague::Model::PublisherReport]
+      def publisher_report(response)
+        reporter = Montague::Reporter::Publisher.new response
+        reporter.report
+      end
+
+    end
+
+  end
+
+end

data/lib/montague/model/archiving.rb

@@ -0,0 +1,26 @@
+module Montague
+  module Model
+
+    # Archiving
+    #
+    class Archiving < Montague::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :permission
+
+      # @return [Array<String>]
+      attr_reader :restrictions
+
+      # @param v [String]
+      def permission=(v)
+        @permission = v if v && !v.empty?
+      end
+
+      # @param v [Array]
+      def restrictions=(v)
+        @restrictions = v if v
+      end
+
+    end
+  end
+end

data/lib/montague/model/copyright_link.rb

@@ -0,0 +1,26 @@
+module Montague
+  module Model
+
+    # Copyright link
+    #
+    class CopyrightLink < Montague::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :text
+
+      # @return [String, nil]
+      attr_reader :url
+
+      # @param v [String]
+      def text=(v)
+        @text = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def url=(v)
+        @url = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/montague/model/funder.rb

@@ -0,0 +1,26 @@
+module Montague
+  module Model
+
+    # Funder
+    #
+    class Funder < Montague::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :acronym
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @param v [String]
+      def acronym=(v)
+        @acronym = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def name=(v)
+        @name = v if v && !v.empty?
+      end
+
+    end
+  end
+end