calendarium-romanum-remote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1922aae05ab92482cef8245ff0af153704256dcf
+  data.tar.gz: 37b09a459b50be3e1e8a85d5df6a55c903bb87dc
+SHA512:
+  metadata.gz: a9d35cac14c7720322963a0470e7025d25a3ca834ddfe7d822459ff89d0e210d4f3125c0c91013215e0faab7d466f27ecfcf01f41add018aa4678a900a82f8b8
+  data.tar.gz: f0306395509292979378465024b9b38bc6378acd38c195de2aa89790edcfb92df0d02d25ae49d710c27c9a28c747d2ff8344680473aae43e5c8e51ca17a2d7a9

data/lib/calendarium-romanum-remote.rb

@@ -0,0 +1,2 @@
+require 'calendarium-romanum'
+require_relative 'calendarium-romanum/remote'

data/lib/calendarium-romanum/remote.rb

@@ -0,0 +1,17 @@
+module CalendariumRomanum
+  module Remote; end
+end
+
+require 'net/http'
+require 'json'
+
+%w(
+version
+calendar
+drivers
+drivers/net_http_driver
+errors
+v0/deserializer
+).each do |path|
+  require_relative File.join('remote', path)
+end

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

@@ -0,0 +1,75 @@
+module CalendariumRomanum
+  module Remote
+    # Mostly API-compatible with CalendariumRomanum::Calendar
+    # (only constructor differs).
+    # Instead of computing calendar data, obtains them
+    # from a remote calendar API
+    # https://github.com/igneus/church-calendar-api
+    class Calendar
+      extend Forwardable
+
+      def initialize(year, calendar_uri, api_version: :v0, driver: :net_http)
+        @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
+
+        # only for most fundamental computations made locally
+        @temporale = Temporale.new(year)
+        # only for API compatibility
+        @sanctorale = nil
+      end
+
+      attr_reader :year
+      attr_reader :temporale
+      attr_reader :sanctorale
+      attr_reader :calendar_uri
+
+      def_delegators :@temporale, :range_check, :season
+
+      def day(*args)
+        # TODO code copied from CalendariumRomanum::Calendar -
+        # extract to a separate method
+        if args.size == 2
+          date = Date.new(@year, *args)
+          unless @temporale.date_range.include? date
+            date = Date.new(@year + 1, *args)
+          end
+        else
+          date = CalendariumRomanum::Calendar.mk_date *args
+          #range_check date
+        end
+
+        serialized = @driver.get date, @calendar_uri
+        @deserializer.call serialized
+      end
+
+      def lectionary
+        year_spec['lectionary'].to_sym
+      end
+
+      def ferial_lectionary
+        year_spec['ferial_lectionary'].to_i
+      end
+
+      def ==(obj)
+        self.class == obj.class &&
+          self.year == obj.year &&
+          self.calendar_uri == obj.calendar_uri
+      end
+
+      private
+
+      def year_spec
+        @year_spec ||= JSON.parse(@driver.year(@year, @calendar_uri))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,52 @@
+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/errors.rb

@@ -0,0 +1,15 @@
+module CalendariumRomanum
+  module Remote
+    # parent of the gem's error classes,
+    # never itself instantiated
+    class Error < ::RuntimeError; end
+
+    # server not found
+    class ServerNotFoundError < Error; end
+
+    # server refuses submitted input
+    class BadRequestError < Error; end
+
+    class TransportError < Error; end
+  end
+end

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

@@ -0,0 +1,28 @@
+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/lib/calendarium-romanum/remote/version.rb

@@ -0,0 +1,6 @@
+module CalendariumRomanum
+  module Remote
+    VERSION = '0.1.0'
+    RELEASE_DATE = Date.new(2017, 9, 2)
+  end
+end

data/spec/calendar_spec.rb

@@ -0,0 +1,104 @@
+require_relative 'spec_helper'
+
+describe CalendariumRomanum::Remote::Calendar do
+  CR = CalendariumRomanum
+  CRR = CalendariumRomanum::Remote
+
+  let(:year) { 2016 }
+  let(:calendar) { described_class.new year, REMOTE_CALENDAR_URI }
+
+  describe '#year' do
+    it 'returns the year passed to the constructor' do
+      y = 2200
+      cal = described_class.new y, REMOTE_CALENDAR_URI
+      expect(cal.year).to eq y
+    end
+  end
+
+  describe '#lectionary' do
+    it { expect(calendar.lectionary).to be :A }
+  end
+
+  describe '#ferial_lectionary' do
+    it { expect(calendar.ferial_lectionary).to be 1 }
+  end
+
+  describe '#==' do
+    describe 'same year and URI' do
+      let(:c) { described_class.new year, REMOTE_CALENDAR_URI }
+
+      it 'is same' do
+        expect(c == calendar).to be true
+      end
+    end
+
+    describe 'year differs' do
+      let(:c) { described_class.new year + 1, REMOTE_CALENDAR_URI }
+
+      it 'is different' do
+        expect(c == calendar).to be false
+      end
+    end
+
+    describe 'URI differs' do
+      let(:c) { described_class.new year, 'http://other.uri' }
+
+      it 'is different' do
+        expect(c == calendar).to be false
+      end
+    end
+  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) }
+
+      cls.public_instance_methods.each do |method|
+        describe method do
+          it 'is defined by origin' do
+            expect(origin).to respond_to method
+          end
+
+          it 'is defined by mirror' do
+            expect(mirror).to respond_to method
+          end
+
+          it 'definitions match' do
+            morig = origin.method method
+            mmirr = mirror.method method
+
+            expect(mmirr.arity).to eq morig.arity
+            expect(mmirr.parameters).to eq morig.parameters
+          end
+        end
+      end
+    end
+  end
+
+  describe 'returns the same data as Calendar' do
+    let(:year) { 2016 }
+
+    # classical calendar
+    let(:sanctorale) { CR::Data::GENERAL_ROMAN_ENGLISH.load }
+    let(:calendar) { CR::Calendar.new(year, sanctorale) }
+
+    # remote calendar with the same settings
+    let(:uri) { REMOTE_CALENDAR_URI }
+    let(:remote) { described_class.new(year, uri) }
+
+    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
+
+        expect(r).to eq c
+      end
+    end
+  end
+end

data/spec/drivers_spec.rb

@@ -0,0 +1,94 @@
+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

data/spec/readme_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+class MarkdownDocument
+  def initialize(str)
+    @str = str
+  end
+
+  def each_ruby_example
+    example = nil
+    line = nil
+    @str.each_line.with_index(1) do |l, i|
+      if example.nil?
+        if example_beginning?(l)
+          example = ''
+          line = i + 1
+        end
+      elsif example_end?(l)
+        yield example, line
+        example = nil
+      else
+        example += l
+      end
+    end
+  end
+
+  protected
+
+  def example_beginning?(line)
+    line =~ /^```ruby/
+  end
+
+  def example_end?(line)
+    line =~ /```/
+  end
+end
+
+%w(README.md).each do |path|
+  describe path do
+    readme_path = File.expand_path('../../' + path, __FILE__)
+    readme = File.read readme_path
+    doc = MarkdownDocument.new readme
+
+    doc.each_ruby_example do |code, line|
+      describe "example L#{line}" do
+        it 'executes without failure' do
+          cls = Class.new
+          cls.class_eval(code, readme_path, line)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+# 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.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows 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. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  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
+end
+
+require_relative '../lib/calendarium-romanum-remote'
+
+REMOTE_CALENDAR_URI =
+  ENV['REMOTE_CALENDAR'] || 'http://calapi.inadiutorium.cz/api/v0/en/calendars/general-en/'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: calendarium-romanum-remote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakub Pavlík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: calendarium-romanum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: obtains calendar data from an API
+email: jkb.pavlik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/errors.rb
+- lib/calendarium-romanum/remote/v0/deserializer.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
+licenses:
+- LGPL-3.0
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: remote calendar extension for calendarium-romanum
+test_files: []