montague 0.2.0

data/lib/montague/model/header.rb

@@ -0,0 +1,22 @@
+module Montague
+  module Model
+    # Header
+    #
+    class Header
+
+      # @return [String, nil]
+      attr_accessor :api_control
+
+      # @return [Fixnum, nil]
+      attr_accessor :hits
+
+      # @return [String, nil]
+      attr_accessor :message
+
+      # @return [String, nil]
+      attr_accessor :outcome
+
+    end
+
+  end
+end

data/lib/montague/model/journal.rb

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

data/lib/montague/model/journal_report.rb

@@ -0,0 +1,15 @@
+module Montague
+  module Model
+    # Journal report
+    #
+    class JournalReport
+      include Montague::Model::ReportHeaderMixin
+      include Montague::Model::ReportHTTPResponseMixin
+      include Montague::Model::ReportPublisherMixin
+
+      # @return [Montague::Model::Journal, nil]
+      attr_accessor :journal
+
+    end
+  end
+end

data/lib/montague/model/journals_report.rb

@@ -0,0 +1,15 @@
+module Montague
+  module Model
+    # Journals report
+    #
+    class JournalsReport
+      include Montague::Model::ReportHeaderMixin
+      include Montague::Model::ReportHTTPResponseMixin
+      include Montague::Model::ReportPublisherMixin
+
+      # @return [Array<Montague::Model::Journal>]
+      attr_accessor :journals
+
+    end
+  end
+end

data/lib/montague/model/mandate.rb

@@ -0,0 +1,44 @@
+module Montague
+  module Model
+
+    # Funder compliance mandate
+    #
+    class Mandate < Montague::Model::Structure
+
+      # @return [Montague::Model::Funder, nil]
+      attr_reader :funder
+
+      # @return [String, nil]
+      attr_reader :publisher_complies
+
+      # @return [String, nil]
+      attr_reader :compliance_type
+
+      # @return [String, nil]
+      attr_reader :selected_titles
+
+      # @param v [String]
+      def funder=(v)
+        @funder = v if v && v.data?
+      end
+
+      # @param v [String]
+      def publisher_complies=(v)
+        @publisher_complies = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def compliance_type=(v)
+        @compliance_type = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def selected_titles=(v)
+        # handle absent negative value in API
+        v = 'no' if v.empty?
+        @selected_titles = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/montague/model/model.rb

@@ -0,0 +1,22 @@
+require 'montague/model/structure'
+require 'montague/model/archiving'
+require 'montague/model/copyright_link'
+require 'montague/model/funder'
+require 'montague/model/publisher'
+require 'montague/model/header'
+require 'montague/model/journal'
+require 'montague/model/mandate'
+require 'montague/model/paid_access'
+require 'montague/model/report_header_mixin'
+require 'montague/model/report_http_response_mixin'
+require 'montague/model/report_publisher_mixin'
+require 'montague/model/journal_report'
+require 'montague/model/journals_report'
+require 'montague/model/publisher_report'
+require 'montague/model/publishers_report'
+
+module Montague
+  # Model
+  module Model
+  end
+end

data/lib/montague/model/paid_access.rb

@@ -0,0 +1,34 @@
+module Montague
+  module Model
+
+    # Paid access
+    #
+    class PaidAccess < Montague::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :url
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @return [String, nil]
+      attr_reader :notes
+
+      # @param v [String]
+      def url=(v)
+        @url = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def name=(v)
+        @name = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def notes=(v)
+        @notes = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/montague/model/publisher.rb

@@ -0,0 +1,46 @@
+module Montague
+  module Model
+
+    # Publisher
+    #
+    class Publisher
+
+      # @return [String]
+      attr_accessor :alias
+
+      # @return [Array<String>]
+      attr_accessor :conditions
+
+      # @return [Array<Montague::Model::CopyrightLink>]
+      attr_accessor :copyright_links
+
+      # @return [String]
+      attr_accessor :id
+
+      # Publisher compliance with the open access mandates of research funding agencies
+      # @return [Array<Montague::Model::Mandate>]
+      attr_accessor :mandates
+
+      # @return [String, nil]
+      attr_accessor :name
+
+      # @return [Montague::Model::PaidAccess, nil]
+      attr_accessor :paid_access
+
+      # Publisher version, with formatting
+      # @return [Montague::Model::Archiving, nil]
+      attr_accessor :pdf_version
+
+      # Submitted version, before peer-review
+      # @return [Montague::Model::Archiving, nil]
+      attr_accessor :pre_prints
+
+      # Accepted version, after peer-review
+      # @return [Montague::Model::Archiving, nil]
+      attr_accessor :post_prints
+
+      # @return [String, nil]
+      attr_accessor :romeo_colour
+    end
+  end
+end

data/lib/montague/model/publisher_report.rb

@@ -0,0 +1,12 @@
+module Montague
+  module Model
+    # Publisher report
+    #
+    class PublisherReport
+      include Montague::Model::ReportHeaderMixin
+      include Montague::Model::ReportHTTPResponseMixin
+      include Montague::Model::ReportPublisherMixin
+
+    end
+  end
+end

data/lib/montague/model/publishers_report.rb

@@ -0,0 +1,14 @@
+module Montague
+  module Model
+    # Publishers report
+    #
+    class PublishersReport
+      include Montague::Model::ReportHeaderMixin
+      include Montague::Model::ReportHTTPResponseMixin
+
+      # @return [Array<Montague::Model::Publisher>]
+      attr_accessor :publishers
+
+    end
+  end
+end

data/lib/montague/model/report_header_mixin.rb

@@ -0,0 +1,12 @@
+module Montague
+  module Model
+    # Report header mixin
+    #
+    module ReportHeaderMixin
+
+      # @return [Montague::Model::Header]
+      attr_accessor :header
+
+    end
+  end
+end

data/lib/montague/model/report_http_response_mixin.rb

@@ -0,0 +1,12 @@
+module Montague
+  module Model
+    # Report HTTP response mixin
+    #
+    module ReportHTTPResponseMixin
+
+      # @return [HTTP::Response]
+      attr_accessor :http_response
+
+    end
+  end
+end

data/lib/montague/model/report_publisher_mixin.rb

@@ -0,0 +1,12 @@
+module Montague
+  module Model
+    # Report publisher mixin
+    #
+    module ReportPublisherMixin
+
+      # @return [Montague::Model::Publisher, nil]
+      attr_accessor :publisher
+
+    end
+  end
+end

data/lib/montague/model/structure.rb

@@ -0,0 +1,18 @@
+module Montague
+  module Model
+
+    # A structure.
+    #
+    class Structure
+
+      def data?
+        found = false
+        instance_variables.each do |i|
+          found = true if i
+        end
+        found
+      end
+
+    end
+  end
+end

data/lib/montague/reporter/journal.rb

@@ -0,0 +1,26 @@
+module Montague
+  module Reporter
+    # Journal reporter
+    #
+    class Journal
+
+      def initialize(response)
+        @response = response
+        @header_extractor = Montague::XMLExtractor::Header.new response.to_s
+        @journal_extractor = Montague::XMLExtractor::Journal.new response.to_s
+        @publisher_extractor = Montague::XMLExtractor::Publisher.new response.to_s
+      end
+
+      # @return [Montague::Model::JournalReport]
+      def report
+        h = Montague::Model::JournalReport.new
+        h.http_response = @response
+        h.header = @header_extractor.model
+        h.journal = @journal_extractor.model
+        h.publisher = @publisher_extractor.model
+        h
+      end
+
+    end
+  end
+end

data/lib/montague/reporter/journals.rb

@@ -0,0 +1,26 @@
+module Montague
+  module Reporter
+    # Journals reporter
+    #
+    class Journals
+
+      def initialize(response)
+        @response = response
+        @header_extractor = Montague::XMLExtractor::Header.new response.to_s
+        @journal_extractor = Montague::XMLExtractor::Journal.new response.to_s
+        @publisher_extractor = Montague::XMLExtractor::Publisher.new response.to_s
+      end
+
+      # @return [Montague::Model::JournalsReport]
+      def report
+        h = Montague::Model::JournalsReport.new
+        h.http_response = @response
+        h.header = @header_extractor.model
+        h.journals = @journal_extractor.models
+        h.publisher = @publisher_extractor.model
+        h
+      end
+
+    end
+  end
+end

data/lib/montague/reporter/publisher.rb

@@ -0,0 +1,24 @@
+module Montague
+  module Reporter
+    # Publisher reporter
+    #
+    class Publisher
+
+      def initialize(response)
+        @response = response
+        @header_extractor = Montague::XMLExtractor::Header.new response.to_s
+        @publisher_extractor = Montague::XMLExtractor::Publisher.new response.to_s
+      end
+
+      # @return [Montague::Model::PublisherReport]
+      def report
+        h = Montague::Model::PublisherReport.new
+        h.http_response = @response
+        h.header = @header_extractor.model
+        h.publisher = @publisher_extractor.model
+        h
+      end
+
+    end
+  end
+end

data/lib/montague/reporter/publishers.rb

@@ -0,0 +1,24 @@
+module Montague
+  module Reporter
+    # Publishers reporter
+    #
+    class Publishers
+
+      def initialize(response)
+        @response = response
+        @header_extractor = Montague::XMLExtractor::Header.new  response.to_s
+        @publisher_extractor = Montague::XMLExtractor::Publisher.new  response.to_s
+      end
+
+      # @return [Montague::Model::PublishersReport]
+      def report
+        h = Montague::Model::PublishersReport.new
+        h.http_response = @response
+        h.header = @header_extractor.model
+        h.publishers = @publisher_extractor.models
+        h
+      end
+
+    end
+  end
+end

data/lib/montague/reporter/reporter.rb

@@ -0,0 +1,11 @@
+require 'montague/reporter/journal'
+require 'montague/reporter/journals'
+require 'montague/reporter/publisher'
+require 'montague/reporter/publishers'
+
+module Montague
+  # Report
+  #
+  module Reporter
+  end
+end