calendarium-romanum-remote 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1922aae05ab92482cef8245ff0af153704256dcf
-  data.tar.gz: 37b09a459b50be3e1e8a85d5df6a55c903bb87dc
+  metadata.gz: a5888b0e5f69d9b5ce0050ffb65e7ce87049d411
+  data.tar.gz: 7a98baf6c8de7f79988fa9a92ef310f239509ef4
 SHA512:
-  metadata.gz: a9d35cac14c7720322963a0470e7025d25a3ca834ddfe7d822459ff89d0e210d4f3125c0c91013215e0faab7d466f27ecfcf01f41add018aa4678a900a82f8b8
-  data.tar.gz: f0306395509292979378465024b9b38bc6378acd38c195de2aa89790edcfb92df0d02d25ae49d710c27c9a28c747d2ff8344680473aae43e5c8e51ca17a2d7a9
+  metadata.gz: 28ca711f6238c89197d45df0c11f655484570a953eae40c57b72e6f7de0760b607569216cddc076616a9a50014e5daf7e267ab5e5820641a4e2cec270189f42e
+  data.tar.gz: 3a2fb22ceddb56e7d97f48726865f7892d95198d46285beaa2a411bc974379257f98e8e30cb914e28e40501ed0135489b6f077a6154b9c52f938fcb226eb3c24

data/lib/calendarium-romanum/remote.rb

@@ -2,16 +2,17 @@ module CalendariumRomanum
   module Remote; end
 end
 
-require 'net/http'
-require 'json'
+require 'httpi'
+require 'multi_json'
+require 'dry-schema'
 
 %w(
 version
 calendar
-drivers
-drivers/net_http_driver
+driver
 errors
-v0/deserializer
+v0/denormalizer
+v0/uri_scheme
 ).each do |path|
   require_relative File.join('remote', path)
 end

data/lib/calendarium-romanum/remote/calendar.rb

@@ -8,18 +8,16 @@ module CalendariumRomanum
     class Calendar
       extend Forwardable
 
-      def initialize(year, calendar_uri, api_version: :v0, driver: :net_http)
+      def initialize(year, calendar_uri, driver: nil)
         @year = year
         @calendar_uri = calendar_uri
+
         @driver =
-          if driver.is_a? Symbol
-            # built-in driver specified by a Symbol
-            Drivers.get(api_version, driver)
-          else
-            # driver instance
-            driver
-          end
-        @deserializer = V0::Deserializer.new
+          driver ||
+          Driver.new(
+            V0::UriScheme.new(calendar_uri),
+            V0::Denormalizer.new
+          )
 
         # only for most fundamental computations made locally
         @temporale = Temporale.new(year)
@@ -47,8 +45,7 @@ module CalendariumRomanum
           #range_check date
         end
 
-        serialized = @driver.get date, @calendar_uri
-        @deserializer.call serialized
+        @driver.day date
       end
 
       def lectionary
@@ -68,7 +65,7 @@ module CalendariumRomanum
       private
 
       def year_spec
-        @year_spec ||= JSON.parse(@driver.year(@year, @calendar_uri))
+        @year_spec ||= @driver.year(@year)
       end
     end
   end

data/lib/calendarium-romanum/remote/driver.rb

@@ -0,0 +1,47 @@
+module CalendariumRomanum
+  module Remote
+    # Orchestrates retrieval and deserialization of calendar data
+    # from a server accessed throught HTTP GET requests
+    # and returning JSON responses.
+    class Driver
+      def initialize(uri_scheme, denormalizer)
+        @uri_scheme = uri_scheme
+        @denormalizer = denormalizer
+      end
+
+      def day(date)
+        process :day, date
+      end
+
+      def year(year)
+        process :year, year
+      end
+
+      protected
+
+      def process(action, argument)
+        uri = @uri_scheme.public_send action, argument
+        response = request uri
+        handle_errors response
+        data = MultiJson.load response.body
+
+        @denormalizer.public_send action, data
+      end
+
+      def request(uri)
+        request = HTTPI::Request.new uri
+        request.headers['Accept'] = 'application/json'
+        request.headers['User-Agent'] =
+          'calendarium-romanum-remote/' + Remote::VERSION
+
+        HTTPI.get request
+      end
+
+      def handle_errors(response)
+        if response.code != 200
+          raise UnexpectedResponseError.new("Unexpected HTTP status #{response.code.inspect}")
+        end
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/remote/errors.rb

@@ -4,12 +4,11 @@ module CalendariumRomanum
     # never itself instantiated
     class Error < ::RuntimeError; end
 
-    # server not found
-    class ServerNotFoundError < Error; end
+    # the server responded with a response which cannot be
+    # transformed to valid calendar data
+    class UnexpectedResponseError < Error; end
 
-    # server refuses submitted input
-    class BadRequestError < Error; end
-
-    class TransportError < Error; end
+    # the server returned data which we don't understand
+    class InvalidDataError < Error; end
   end
 end

data/lib/calendarium-romanum/remote/v0/denormalizer.rb

@@ -0,0 +1,61 @@
+module CalendariumRomanum
+  module Remote
+    module V0
+      class Denormalizer
+        def day(day_json)
+          check day_json, DaySchema
+
+          season_sym = day_json['season'].to_sym
+
+          CalendariumRomanum::Day.new(
+            date: Date.parse(day_json['date']),
+            season: CalendariumRomanum::Seasons.all.find {|s| s.symbol == season_sym},
+            season_week: day_json['season_week'],
+            celebrations: day_json['celebrations'].collect do |c|
+              colour_sym = c['colour'].to_sym
+
+              CalendariumRomanum::Celebration.new(
+                c['title'],
+                CalendariumRomanum::Ranks[c['rank_num']],
+                CalendariumRomanum::Colours.all.find {|c| c.symbol == colour_sym }
+              )
+            end
+          )
+        end
+
+        def year(year_json)
+          check year_json, YearSchema
+
+          # no denormalization takes place
+          year_json
+        end
+
+        protected
+
+        def check(data, schema)
+          errors = schema.call(data).errors
+
+          unless errors.empty?
+            raise InvalidDataError.new "Invalid data: #{errors.to_h}"
+          end
+        end
+
+        DaySchema = Dry::Schema.JSON do
+          required(:date).filled(:string, format?: /^\d{4}-\d{2}-\d{2}$/)
+          required(:season).filled(:string)
+          required(:season_week).filled(:integer)
+          required(:celebrations).array(:hash) do
+            required(:title).filled(:string)
+            required(:colour).filled(:string)
+            required(:rank_num).filled(:float)
+          end
+        end
+
+        YearSchema = Dry::Schema.JSON do
+          required(:lectionary).filled(:string, included_in?: %w(A B C))
+          required(:ferial_lectionary).filled(:integer, included_in?: [1, 2])
+        end
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/remote/v0/uri_scheme.rb

@@ -0,0 +1,21 @@
+module CalendariumRomanum
+  module Remote
+    module V0
+      class UriScheme
+        def initialize(calendar_uri)
+          @calendar_uri =
+            calendar_uri +
+            (calendar_uri.end_with?('/') ? '' : '/')
+        end
+
+        def day(date)
+          @calendar_uri + "#{date.year}/#{date.month}/#{date.day}"
+        end
+
+        def year(year)
+          @calendar_uri + year.to_s
+        end
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/remote/version.rb

@@ -1,6 +1,8 @@
+require 'date'
+
 module CalendariumRomanum
   module Remote
-    VERSION = '0.1.0'
-    RELEASE_DATE = Date.new(2017, 9, 2)
+    VERSION = '0.2.0'
+    RELEASE_DATE = Date.new(2019, 9, 22)
   end
 end

data/spec/calendar_spec.rb

@@ -1,16 +1,19 @@
 require_relative 'spec_helper'
 
+# integration tests exercizing the whole stack and
+# making (a lot of) actual HTTP requests!
 describe CalendariumRomanum::Remote::Calendar do
   CR = CalendariumRomanum
-  CRR = CalendariumRomanum::Remote
+  CRRemote = CalendariumRomanum::Remote
 
   let(:year) { 2016 }
-  let(:calendar) { described_class.new year, REMOTE_CALENDAR_URI }
+  let(:uri) { REMOTE_CALENDAR_URI }
+  let(:calendar) { described_class.new year, uri }
 
   describe '#year' do
     it 'returns the year passed to the constructor' do
       y = 2200
-      cal = described_class.new y, REMOTE_CALENDAR_URI
+      cal = described_class.new y, uri
       expect(cal.year).to eq y
     end
   end
@@ -25,7 +28,7 @@ describe CalendariumRomanum::Remote::Calendar do
 
   describe '#==' do
     describe 'same year and URI' do
-      let(:c) { described_class.new year, REMOTE_CALENDAR_URI }
+      let(:c) { described_class.new year, uri }
 
       it 'is same' do
         expect(c == calendar).to be true
@@ -33,7 +36,7 @@ describe CalendariumRomanum::Remote::Calendar do
     end
 
     describe 'year differs' do
-      let(:c) { described_class.new year + 1, REMOTE_CALENDAR_URI }
+      let(:c) { described_class.new year + 1, uri }
 
       it 'is different' do
         expect(c == calendar).to be false
@@ -50,15 +53,13 @@ describe CalendariumRomanum::Remote::Calendar do
   end
 
   describe 'API-compatibility with Calendar' do
-    cls = CR::Calendar
-
     describe 'instance methods' do
       let(:year) { 2000 }
 
       let(:origin) { CR::Calendar.new(year) }
-      let(:mirror) { CRR::Calendar.new(year, REMOTE_CALENDAR_URI) }
+      let(:mirror) { CRRemote::Calendar.new(year, uri) }
 
-      cls.public_instance_methods.each do |method|
+      CR::Calendar.public_instance_methods.each do |method|
         describe method do
           it 'is defined by origin' do
             expect(origin).to respond_to method
@@ -81,24 +82,76 @@ describe CalendariumRomanum::Remote::Calendar do
   end
 
   describe 'returns the same data as Calendar' do
-    let(:year) { 2016 }
-
-    # classical calendar
+    # classical calendar with the same settings as `calendar`
     let(:sanctorale) { CR::Data::GENERAL_ROMAN_ENGLISH.load }
-    let(:calendar) { CR::Calendar.new(year, sanctorale) }
+    let(:local_calendar) { CR::Calendar.new(year, sanctorale) }
 
-    # remote calendar with the same settings
-    let(:uri) { REMOTE_CALENDAR_URI }
-    let(:remote) { described_class.new(year, uri) }
+    let(:remote_calendar) { calendar }
 
     days = (CR::Temporale::Dates.first_advent_sunday(2016) ... CR::Temporale::Dates.first_advent_sunday(2017))
       days.each do |date|
       it date do
-        c = calendar.day date
-        r = remote.day date
+        c = local_calendar.day date
+        r = remote_calendar.day date
 
         expect(r).to eq c
       end
     end
   end
+
+  describe 'errors' do
+    let(:date) { Date.new year, 1, 1 }
+
+    describe 'server does not exist' do
+      let(:uri) { 'http://does-not-exist.local/' }
+
+      it 'throws SocketError' do
+        expect do
+          calendar.day date
+        end.to raise_exception ::SocketError
+      end
+    end
+
+    describe 'server exists, wrong calendar URI' do
+      let(:wrong_calendar_uri) { uri + 'another-path-segment/' }
+      let(:calendar) { described_class.new year, wrong_calendar_uri }
+
+      it 'throws CalendariumRomanum::Remote::UnexpectedResponseError' do
+        expect do
+          calendar.day date
+        end.to raise_exception CRRemote::UnexpectedResponseError, /Unexpected HTTP status 404/
+      end
+    end
+
+    describe 'bad request - invalid date' do
+      # this shouldn't ever happen, but it's the easiest way
+      # to check how the calendar behaves in bad request scenarios
+      let(:date) do
+        d = Date.new
+        d.stub(:year) { 2000 }
+        d.stub(:month) { 13 }
+        d.stub(:day) { 40 }
+
+        d
+      end
+
+      it 'throws CalendariumRomanum::Remote::UnexpectedResponseError' do
+        expect do
+          calendar.day date
+        end.to raise_exception CRRemote::UnexpectedResponseError, /Unexpected HTTP status 400/
+      end
+    end
+
+    describe 'unsupported response content' do
+      it 'fails' do
+        # HTTP request will return empty JSON
+        response = HTTPI::Response.new 200, {}, '{}'
+        allow(HTTPI).to receive(:get).and_return(response)
+
+        expect do
+          calendar.day date
+        end.to raise_exception CRRemote::InvalidDataError, /Invalid data: {:date=>\["is missing"/
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 # 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
@@ -103,3 +106,5 @@ require_relative '../lib/calendarium-romanum-remote'
 
 REMOTE_CALENDAR_URI =
   ENV['REMOTE_CALENDAR'] || 'http://calapi.inadiutorium.cz/api/v0/en/calendars/general-en/'
+
+HTTPI.log = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendarium-romanum-remote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jakub Pavlík
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-02 00:00:00.000000000 Z
+date: 2019-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: calendarium-romanum
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -61,13 +103,12 @@ files:
 - lib/calendarium-romanum-remote.rb
 - lib/calendarium-romanum/remote.rb
 - lib/calendarium-romanum/remote/calendar.rb
-- lib/calendarium-romanum/remote/drivers.rb
-- lib/calendarium-romanum/remote/drivers/net_http_driver.rb
+- lib/calendarium-romanum/remote/driver.rb
 - lib/calendarium-romanum/remote/errors.rb
-- lib/calendarium-romanum/remote/v0/deserializer.rb
+- lib/calendarium-romanum/remote/v0/denormalizer.rb
+- lib/calendarium-romanum/remote/v0/uri_scheme.rb
 - lib/calendarium-romanum/remote/version.rb
 - spec/calendar_spec.rb
-- spec/drivers_spec.rb
 - spec/readme_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/igneus/calendarium-romanum-remote
@@ -91,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: remote calendar extension for calendarium-romanum

data/lib/calendarium-romanum/remote/drivers.rb

@@ -1,17 +0,0 @@
-module CalendariumRomanum
-  module Remote
-    module Drivers
-      def self.get(api_version, driver_id)
-        if api_version == :v0
-          if driver_id == :net_http
-            return NetHttpDriver.new
-          else
-            raise ArgumentError.new("Unsupported driver #{driver_id}")
-          end
-        else
-          raise ArgumentError.new("Unsupported API version #{api_version.inspect}")
-        end
-      end
-    end
-  end
-end

data/lib/calendarium-romanum/remote/drivers/net_http_driver.rb

@@ -1,52 +0,0 @@
-module CalendariumRomanum
-  module Remote
-    module Drivers
-      # Communicates with the remote API using Ruby standard library
-      class NetHttpDriver
-        def get(date, calendar_uri)
-          uri_str =
-            calendar_uri +
-            (calendar_uri.end_with?('/') ? '' : '/') +
-            "#{date.year}/#{date.month}/#{date.day}"
-          uri = URI(uri_str)
-
-          get_request uri
-        end
-
-        def year(year, calendar_uri)
-          uri_str =
-            calendar_uri +
-            (calendar_uri.end_with?('/') ? '' : '/') +
-            year.to_s
-          uri = URI(uri_str)
-
-          get_request uri
-        end
-
-        private
-
-        def get_request(uri)
-          begin
-            response = Net::HTTP.get_response uri
-          rescue SocketError, Errno::ECONNREFUSED => err
-            raise ServerNotFoundError.new err.message
-          rescue Timeout::Error, Errno::EINVAL,
-                 Errno::ECONNRESET, EOFError,
-                 Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
-                 Net::ProtocolError => err
-            raise TransportError.new err.message
-          end
-
-          if response.code == '200'
-            return response.body
-          elsif response.code == '400'
-            json = JSON.parse(response.body)
-            raise BadRequestError.new(json['error'])
-          else
-            raise Error.new("Unexpected status #{response.code.inspect}")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/calendarium-romanum/remote/v0/deserializer.rb

@@ -1,28 +0,0 @@
-module CalendariumRomanum
-  module Remote
-    module V0
-      class Deserializer
-        def call(day_str)
-          parsed = JSON.parse day_str
-
-          season_sym = parsed['season'].to_sym
-
-          CalendariumRomanum::Day.new(
-            date: Date.parse(parsed['date']),
-            season: CalendariumRomanum::Seasons.all.find {|s| s.symbol == season_sym},
-            season_week: parsed['season_week'],
-            celebrations: parsed['celebrations'].collect do |c|
-              colour_sym = c['colour'].to_sym
-
-              CalendariumRomanum::Celebration.new(
-                c['title'],
-                CalendariumRomanum::Ranks[c['rank_num']],
-                CalendariumRomanum::Colours.all.find {|c| c.symbol == colour_sym }
-              )
-            end
-          )
-        end
-      end
-    end
-  end
-end

data/spec/drivers_spec.rb

@@ -1,94 +0,0 @@
-require 'spec_helper'
-
-describe CalendariumRomanum::Remote::Drivers do
-  CRRem = CalendariumRomanum::Remote
-
-  let(:base_uri) { REMOTE_CALENDAR_URI }
-  let(:date) { Date.new 2000, 1, 1 }
-
-  shared_examples 'any driver' do
-    describe 'success' do
-      it 'returns a string' do
-        r = driver.get date, base_uri
-        expect(r).to be_a String
-        expect(r).not_to be_empty
-      end
-
-      it 'returns a valid JSON' do
-        r = driver.get date, base_uri
-        expect do
-          JSON.parse(r)
-        end.not_to raise_exception
-      end
-    end
-
-    describe 'server not found' do
-      let(:base_uri) { 'http://unknown.server.xyz' }
-
-      it 'fails' do
-        expect do
-          driver.get date, base_uri
-        end.to raise_exception CRRem::ServerNotFoundError
-      end
-    end
-
-    describe 'connection refused' do
-      let(:base_uri) { 'http://localhost:33333' }
-
-      it 'fails' do
-        expect do
-          driver.get date, base_uri
-        end.to raise_exception CRRem::ServerNotFoundError
-      end
-    end
-
-    describe 'calendar not found' do
-      let(:base_uri) { REMOTE_CALENDAR_URI.sub(/(?<=calendars\/).*$/, 'unknown-calendar') }
-
-      it 'fails' do
-        expect do
-          driver.get date, base_uri
-        end.to raise_exception CRRem::BadRequestError
-      end
-    end
-
-    describe 'invalid date' do
-      # this won't ever happen, but the driver must be prepared
-      # to handle bad request scenarios
-      let(:date) { double(year: 2000, month: 13, day: 40) }
-
-      it 'fails' do
-        expect do
-          driver.get date, base_uri
-        end.to raise_exception CRRem::BadRequestError
-      end
-    end
-  end
-
-  describe CalendariumRomanum::Remote::Drivers::NetHttpDriver do
-    let(:driver) { described_class.new }
-
-    it_behaves_like 'any driver'
-
-    # implementation-specific error handling
-    describe 'network error' do
-      [
-        Timeout::Error,
-        Errno::EINVAL,
-        Errno::ECONNRESET,
-        EOFError,
-        Net::HTTPBadResponse,
-        Net::HTTPHeaderSyntaxError,
-        Net::ProtocolError
-      ].each do |etype|
-        it 'fails' do
-          allow(Net::HTTP).to receive(:get_response).and_raise(etype)
-
-          expect do
-            driver.get date, base_uri
-          end.to raise_exception CRRem::TransportError
-        end
-      end
-    end
-  end
-end