votd 3.0.2 → 4.0.1

data/lib/votd/helper/command_line.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Votd
   module Helper
     # This module contains helper methods that support the
     # command-line application
     module CommandLine
       extend self
+
       # Generates a text banner suitable for displaying from a command-line
       # utility.
       # @example
@@ -13,15 +16,12 @@ module Votd
       #   ====================
       #        My Banner
       #   ====================
-      # @param [Integer] line_width number of columns for width
       # @param [String] text text to print inside the banner
+      # @param [Integer] line_width number of columns for width
       # @return [nil]
-      def banner(text, line_width=40)
-        banner_text = "=" * line_width
-        banner_text << "\n"
-        banner_text << text.center(line_width)
-        banner_text << "\n"
-        banner_text <<  "=" * line_width
+      def banner(text, line_width = 40)
+        separator = "=" * line_width
+        banner_text = [separator, text.center(line_width), separator].join("\n")
         puts banner_text
         nil
       end
@@ -30,9 +30,9 @@ module Votd
       # @param [String] text the text to be wrapped
       # @param [Integer] line_width column width
       # @return [String] wrapped text
-      def word_wrap(text, line_width=40)
+      def word_wrap(text, line_width = 40)
         text.split("\n").collect do |line|
-          line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
+          (line.length > line_width) ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
         end * "\n"
       end
     end

data/lib/votd/helper/text.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
 module Votd
+  # Namespace for helper modules used internally by VotD providers and the CLI.
   module Helper
     # This module contains helper methods that support the
     # VotD text parsing.
     module Text
       extend self
+
       # Removes HTML tags from the given text
       # @param [String] text the text you want to strip HTML tags from
       # @return [String]
       def strip_html_tags(text)
-        text.gsub(/<\/?[^>]*>/, '')
+        text.gsub(/<\/?[^>]*>/, "")
       end
-      
+
       # Prepends '...' if first letter is not a capital letter
       # @param [String] text the text to process
       # @return [String]
@@ -23,16 +27,14 @@ module Votd
       # @return [String]
       def clean_verse_end(text)
         case text
-        when /[a-zA-Z]$/         # no ending "."
-          text << '...'
+        when /[a-zA-Z]$/
+          "#{text}..."
         when /[,;]$/
-          text.sub!(/[,;]$/, '...') # ends with "," or ";"
+          text.sub(/[,;]$/, "...")
         else
           text
         end
-        text
       end
-
     end
   end
 end

data/lib/votd/netbible.rb

@@ -1,29 +1,35 @@
-require 'votd/helper/text'
+# frozen_string_literal: true
 
 module Votd
-  # Retrieves a Verse of the Day from http://bible.org using the NETBible
+  # Retrieves a Verse of the Day from https://labs.bible.org using the NETBible
   # translation.
+  #
+  # @example
+  #   votd = Votd::NetBible.new
+  #   votd.text       # => "For God so loved the world..."
+  #   votd.reference  # => "John 3:16"
+  #   votd.version    # => "NETBible"
   class NetBible < Votd::Base
     # The name of the Bible Translation that this module generates
-    BIBLE_VERSION = 'NETBible'
-    BIBLE_VERSION_NAME = 'NET Bible'
+    BIBLE_VERSION = "NETBible"
+    # The full name of the Bible translation
+    BIBLE_VERSION_NAME = "NET Bible"
 
-    # The URI of the API gateway
-    URI = "http://labs.bible.org/api/?passage=votd&type=json"
+    # The URL of the API gateway
+    ENDPOINT_URL = "https://labs.bible.org/api/?passage=votd&type=json"
 
-    # The URI of the website to view the verse (used in ``.link``)
-    NET_BIBLE_URI = "https://netbible.org/bible"
-
-    # Initializes the NetBible class
-    # @return [Votd::NetBible]
-    def initialize
-      super
-    end
+    # The URL of the website to view the verse (used in ``.link``)
+    NET_BIBLE_URL = "https://netbible.org/bible"
 
     private
-    # Gets the verse in JSON format from bible.org
+
+    # Fetches the verse of the day in JSON format from bible.org.
+    # Parses the response, builds the reference, cleans the verse text,
+    # and generates a link to the passage.
+    # @raise [FetchError] if the HTTP request or JSON parsing fails
+    # @return [void]
     def get_votd
-      netbible_data = JSON.parse(HTTParty.get(URI))
+      netbible_data = JSON.parse(HTTParty.get(ENDPOINT_URL))
 
       # use bookname from first verse -- assume votd won't span books
       bookname = netbible_data[0]["bookname"]
@@ -31,16 +37,12 @@ module Votd
       # use chapter from first verse -- assume votd won't span chapters
       chapter = netbible_data[0]["chapter"]
 
-      # loop through each verse to get the verse numbers and verse text
-      verse_numbers = Array.new
-      verses        = Array.new
-      netbible_data.each do |verse|
-        verse_numbers << verse["verse"]
-        verses        << verse["text"]
-      end
+      verse_numbers = netbible_data.map { |v| v["verse"] }
+      verses = netbible_data.map { |v| v["text"] }
 
       # now build the reference
-      @reference = "#{bookname} #{chapter}:#{verse_numbers.join("-")}"
+      @reference = "#{bookname} #{chapter}:#{verse_numbers.first}"
+      @reference += "-#{verse_numbers.last}" if verse_numbers.size > 1
 
       # build the text
       text = Helper::Text.strip_html_tags(verses.join(" "))
@@ -53,15 +55,17 @@ module Votd
       @version_name = BIBLE_VERSION_NAME
 
       @link = generate_link(bookname, chapter, verse_numbers.first)
-
     rescue => e
-      # use default info for VotD
-      set_defaults
-      # @todo Add logging
+      report_and_raise(e, "Failed to fetch verse from NetBible")
     end
 
+    # Generates a URL to the verse on netbible.org.
+    # @param [String] bookname the book name (e.g. "John")
+    # @param [String] chapter the chapter number
+    # @param [String] verse_number the starting verse number
+    # @return [String] the full URL to the passage
     def generate_link(bookname, chapter, verse_number)
-      "#{NET_BIBLE_URI}/#{bookname}+#{chapter}:#{verse_number}"
+      "#{NET_BIBLE_URL}/#{bookname}+#{chapter}:#{verse_number}"
     end
   end
 end

data/lib/votd/ourmanna.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Votd
+  # Retrieves a Verse of the Day from https://ourmanna.com using the NIV
+  # translation.
+  #
+  # @example
+  #   votd = Votd::OurManna.new
+  #   votd.text       # => "For God so loved the world..."
+  #   votd.reference  # => "John 3:16"
+  #   votd.version    # => "NIV"
+  class OurManna < Votd::Base
+    # The name of the Bible Translation that this module generates
+    BIBLE_VERSION = "NIV"
+    # The full name of the Bible translation
+    BIBLE_VERSION_NAME = "New International Version"
+
+    # The URL of the API gateway
+    ENDPOINT_URL = "https://beta.ourmanna.com/api/v1/get?format=json&order=daily"
+
+    private
+
+    # Fetches the verse of the day in JSON format from ourmanna.com.
+    # Parses the response and extracts reference, text, link, and copyright.
+    # @raise [FetchError] if the HTTP request or JSON parsing fails
+    # @return [void]
+    def get_votd
+      data = JSON.parse(HTTParty.get(ENDPOINT_URL).body)
+      details = data["verse"]["details"]
+
+      @reference = details["reference"]
+      @version = BIBLE_VERSION
+      @version_name = BIBLE_VERSION_NAME
+      @link = details["verseurl"]
+
+      text = Helper::Text.strip_html_tags(details["text"])
+      text = Helper::Text.clean_verse_start(text)
+      @text = Helper::Text.clean_verse_end(text)
+
+      @copyright = data["verse"]["notice"]
+    rescue => e
+      report_and_raise(e, "Failed to fetch verse from OurManna")
+    end
+  end
+end

data/lib/votd/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Votd
   # Gem version number
-  VERSION = "3.0.2"
+  VERSION = "4.0.1"
 end

data/lib/votd/votd_error.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module Votd
   # Votd exception class. This will be thrown on errors returned
   # by Votd.
   class VotdError < StandardError
   end
 
+  # Raised when an unknown Bible version symbol is passed to
+  # {BibleGateway#initialize}.
   class InvalidBibleVersion < VotdError
   end
 end

data/lib/votd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "time"
 require "json"
 require "httparty"
@@ -5,12 +7,52 @@ require "httparty"
 # This class acts as the entry point to all sub-modules that are used
 # to interact with various Verse of the Day web services.
 module Votd
+  class << self
+    # Set a Logger-compatible object to receive error messages when
+    # a provider fails to fetch a verse.
+    #
+    # @example
+    #   Votd.logger = Logger.new($stderr)
+    attr_accessor :logger
+
+    # Register a callback to be invoked when a provider error occurs.
+    # The block receives the provider class and the wrapped FetchError.
+    #
+    # @example
+    #   Votd.on_error do |provider_class, error|
+    #     Sentry.capture_exception(error)
+    #   end
+    #
+    # @yield [provider_class, error] invoked when a provider fails
+    # @yieldparam [Class] provider_class the provider class that failed (e.g. Votd::BibleGateway)
+    # @yieldparam [FetchError] error the wrapped exception
+    # @return [void]
+    def on_error(&block)
+      @on_error = block
+    end
+
+    # Returns the registered on_error callback, if any.
+    # @api private
+    # @return [Proc, nil]
+    def on_error_callback
+      @on_error
+    end
+
+    # Resets logger and on_error callback. Useful in tests.
+    # @return [void]
+    def reset_configuration
+      @logger = nil
+      @on_error = nil
+    end
+  end
 end
 
 require "votd/helper/text"
 require "votd/version"
 require "votd/votd_error"
+require "votd/fetch_error"
 require "votd/base"
 require "votd/bible_gateway"
 require "votd/netbible"
+require "votd/ourmanna"
 require "votd/esvbible"

metadata

@@ -1,217 +1,90 @@
 --- !ruby/object:Gem::Specification
 name: votd
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.1
 platform: ruby
 authors:
 - Steve Clarke
-- Chris Clarke
-autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: feedjira
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.24'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.24'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '1.3'
+description: A Ruby gem that wraps Bible verse-of-the-day web services including BibleGateway,
+  NetBible, and OurManna. Provides both a library and CLI.
 email:
 - steve@sevenview.ca
-- chris@seven7.ca
 executables:
 - votd
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
-- TODO.md
-- bin/votd
+- exe/votd
 - lib/votd.rb
 - lib/votd/base.rb
 - lib/votd/bible_gateway.rb
+- lib/votd/cli.rb
 - lib/votd/esvbible.rb
+- lib/votd/fetch_error.rb
 - lib/votd/helper/command_line.rb
-- lib/votd/helper/helper.rb
 - lib/votd/helper/text.rb
 - lib/votd/netbible.rb
+- lib/votd/ourmanna.rb
 - lib/votd/version.rb
 - lib/votd/votd_error.rb
-- spec/fixtures/base/base.html
-- spec/fixtures/base/base.txt
-- spec/fixtures/base/base_custom.html
-- spec/fixtures/base/base_custom.txt
-- spec/fixtures/bible_gateway/bible_gateway.html
-- spec/fixtures/bible_gateway/bible_gateway.rss
-- spec/fixtures/bible_gateway/bible_gateway.txt
-- spec/fixtures/bible_gateway/bible_gateway_custom.html
-- spec/fixtures/bible_gateway/bible_gateway_custom.txt
-- spec/fixtures/bible_gateway/bible_gateway_nlt.rss
-- spec/fixtures/bible_gateway/bible_gateway_with_partial.rss
-- spec/fixtures/esvbible/esvbible.html
-- spec/fixtures/esvbible/esvbible.rss
-- spec/fixtures/esvbible/esvbible.txt
-- spec/fixtures/esvbible/esvbible_custom.html
-- spec/fixtures/esvbible/esvbible_custom.txt
-- spec/fixtures/esvbible/esvbible_with_partial.rss
-- spec/fixtures/netbible/netbible.html
-- spec/fixtures/netbible/netbible.json
-- spec/fixtures/netbible/netbible.txt
-- spec/fixtures/netbible/netbible_custom.html
-- spec/fixtures/netbible/netbible_custom.txt
-- spec/fixtures/netbible/netbible_with_html.json
-- spec/fixtures/netbible/netbible_with_partial.json
-- spec/lib/votd/base_spec.rb
-- spec/lib/votd/bible_gateway_spec.rb
-- spec/lib/votd/esvbible_spec.rb
-- spec/lib/votd/helper/command_line_spec.rb
-- spec/lib/votd/helper/helper_spec.rb
-- spec/lib/votd/helper/text_spec.rb
-- spec/lib/votd/netbible_spec.rb
-- spec/lib/votd/version_spec.rb
-- spec/lib/votd/votd_error_spec.rb
-- spec/lib/votd_spec.rb
-- spec/spec_helper.rb
-- votd.gemspec
 homepage: https://github.com/sevenview/votd
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/sevenview/votd
+  source_code_uri: https://github.com/sevenview/votd
+  changelog_uri: https://github.com/sevenview/votd/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
 - lib
@@ -219,50 +92,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '3.3'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Generate a (Bible) Verse of the Day using various web service wrappers
-test_files:
-- spec/fixtures/base/base.html
-- spec/fixtures/base/base.txt
-- spec/fixtures/base/base_custom.html
-- spec/fixtures/base/base_custom.txt
-- spec/fixtures/bible_gateway/bible_gateway.html
-- spec/fixtures/bible_gateway/bible_gateway.rss
-- spec/fixtures/bible_gateway/bible_gateway.txt
-- spec/fixtures/bible_gateway/bible_gateway_custom.html
-- spec/fixtures/bible_gateway/bible_gateway_custom.txt
-- spec/fixtures/bible_gateway/bible_gateway_nlt.rss
-- spec/fixtures/bible_gateway/bible_gateway_with_partial.rss
-- spec/fixtures/esvbible/esvbible.html
-- spec/fixtures/esvbible/esvbible.rss
-- spec/fixtures/esvbible/esvbible.txt
-- spec/fixtures/esvbible/esvbible_custom.html
-- spec/fixtures/esvbible/esvbible_custom.txt
-- spec/fixtures/esvbible/esvbible_with_partial.rss
-- spec/fixtures/netbible/netbible.html
-- spec/fixtures/netbible/netbible.json
-- spec/fixtures/netbible/netbible.txt
-- spec/fixtures/netbible/netbible_custom.html
-- spec/fixtures/netbible/netbible_custom.txt
-- spec/fixtures/netbible/netbible_with_html.json
-- spec/fixtures/netbible/netbible_with_partial.json
-- spec/lib/votd/base_spec.rb
-- spec/lib/votd/bible_gateway_spec.rb
-- spec/lib/votd/esvbible_spec.rb
-- spec/lib/votd/helper/command_line_spec.rb
-- spec/lib/votd/helper/helper_spec.rb
-- spec/lib/votd/helper/text_spec.rb
-- spec/lib/votd/netbible_spec.rb
-- spec/lib/votd/version_spec.rb
-- spec/lib/votd/votd_error_spec.rb
-- spec/lib/votd_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/workflows/ruby.yml

@@ -1,20 +0,0 @@
-name: Ruby
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake

data/.gitignore

@@ -1,19 +0,0 @@
-*.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/.rspec

@@ -1,2 +0,0 @@
---color
---format documentation

data/.ruby-version

@@ -1 +0,0 @@
-2.6.5

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-notifications:
-  email:
-    recipients:
-      - steve@sevenview.ca
-    on_success: always
-    on_failure: always

data/.yardopts

@@ -1,7 +0,0 @@
---title "VotD - (Bible) Verse of the Day"
-lib/**/*
--
-CONTRIBUTING.md
-CHANGELOG.md
-LICENSE
-TODO.md