ecfr 1.0.0

data/lib/ecfr/search_service/content_version.rb

@@ -0,0 +1,85 @@
+module Ecfr
+  module SearchService
+    class ContentVersion < Base
+      require_relative "./content_version/count"
+      require_relative "./content_version/hierarchichal_result"
+      require_relative "./content_version/result"
+      require_relative "./content_version/suggestion"
+      require_relative "./content_version/summary"
+
+      #
+      # Metadata about the number of matching items
+      #
+      # @param [<Hash>] args valid search arguments, see {Result.find}
+      #
+      # @return [<Count>] count metadata
+      #
+      def self.count(args)
+        lookup(Ecfr::SearchService::ContentVersion::Count).find(args)
+      end
+
+      #
+      # Search results in a hierarchical format with score data
+      #
+      # @param [<Hash>] args valid search arguments, see {Result.find}
+      #
+      # @return [<HierarchicalSearchCount>] hierarchical search results
+      #
+      def self.hierarchical_search(args)
+        lookup(
+          Ecfr::SearchService::ContentVersion::HierarchicalResult
+        ).find(args)
+      end
+
+      #
+      # Search results with excerpts and score data
+      #
+      # @param [<Hash>] args valid search arguments, see {Result.find}
+      #
+      # @return [<Result>] results of a search
+      #
+      def self.search(args)
+        lookup(Ecfr::SearchService::ContentVersion::Result).find(args)
+      end
+
+      #
+      # Suggestions based on the content of a search.
+      # Currently suggests direct link to a portion of the CFR when
+      # a CFR citation is detected as part of the `query`
+      #
+      # @param [<Hash>] args valid search arguments, see {Result.find}
+      #
+      # @return [<Suggestion>] search suggestions
+      #
+      def self.suggestions(args)
+        lookup(Ecfr::SearchService::ContentVersion::Suggestion).find(args)
+      end
+
+      #
+      # Summary of the search based on the arguments provided
+      # - summary only makes use of the :hierarchy and :query
+      # args currenly
+      #
+      # @param [<Hash>] args valid search arguments, see {Result.find}
+      #
+      # @return [<Summary>] A descriptive summary of the search
+      #
+      def self.summary(args)
+        lookup(Ecfr::SearchService::ContentVersion::Summary).find(args)
+      end
+
+      #
+      # Support inheritance by looking up class. See
+      # Ecfr::Extensible for details.
+      #
+      def self.lookup(klass)
+        if const_defined?("#{klass}::KLASS")
+          klass::KLASS
+        else
+          klass
+        end
+      end
+      private_class_method :lookup
+    end
+  end
+end

data/lib/ecfr/search_service/date_facet.rb

@@ -0,0 +1,19 @@
+module Ecfr
+  module SearchService
+    class DateFacet < FacetBase
+      include FacetAttributeMethodDefinition
+
+      result_key :dates
+
+      attribute :count, as: :value
+      attribute :date, type: :date, as: :key
+
+      # @param [<Symbol, String>] type currently only supports :daily
+      # @return [<DateFacet>] counts by date
+      def self.search(type, options = {})
+        # no-op documentation only
+        super(type, options)
+      end
+    end
+  end
+end

data/lib/ecfr/search_service/facet_base.rb

@@ -0,0 +1,55 @@
+module Ecfr
+  module SearchService
+    class FacetBase < Base
+      COUNTS_PATH = "v1/counts"
+
+      #
+      # Retrive counts of changed CFR sections by date
+      #
+      # @param [<Hash>] args valid facet search parameters
+      # @option options [<Ecfr::SearchService::ContentVersion::Hierarchy>] :hierarchy levels of CFR hierarchy to limit the search to
+      # @option options [<String>] :last_modified_after ISO date
+      # @option options [<String>] :last_modified_on_or_after ISO date
+      # @option options [<String>] :last_modified_before ISO date
+      # @option options [<String>] :last_modified_on_or_before ISO date
+      # @option options [<String>] :query search terms
+      # @option options [<Boolean>] :reserved whether counts should be for Reserved content (default false)
+      # @option options [<Boolean>] :substantive whether counts should be for substantive content (default true)
+      #
+      # @return [<DateFacet>] counts by date
+      #
+      def self.search(type, args = {})
+        prepare_search_options(args)
+
+        perform(
+          :get,
+          counts_path(type),
+          params: args
+        )
+      end
+
+      def self.counts_path(type)
+        "#{COUNTS_PATH}/#{type}"
+      end
+      private_class_method :counts_path
+
+      VALID_SEARCH_OPTIONS = %i[
+        hierarchy last_modified_after last_modified_on_or_after
+        last_modified_before last_modified_on_or_before query reserved
+        substantive
+      ]
+
+      def self.prepare_search_options(args)
+        args.deep_symbolize_keys!
+        args.slice!(*VALID_SEARCH_OPTIONS)
+
+        if args[:hierarchy]
+          args[:hierarchy] = args[:hierarchy].slice(
+            *Ecfr::Constants::Hierarchy::HIERARCHY_LEVELS.map(&:to_sym)
+          )
+        end
+      end
+      private_class_method :prepare_search_options
+    end
+  end
+end

data/lib/ecfr/search_service/status.rb

@@ -0,0 +1,7 @@
+module Ecfr
+  module SearchService
+    class Status < Base
+      include DefaultStatusSetup
+    end
+  end
+end

data/lib/ecfr/search_service/title_facet.rb

@@ -0,0 +1,18 @@
+module Ecfr
+  module SearchService
+    class TitleFacet < FacetBase
+      include FacetAttributeMethodDefinition
+
+      result_key :titles
+
+      attribute :count, as: :value
+      attribute :title, as: :key
+
+      # @return [<TitleFacet>] counts by title
+      def self.search(options = {})
+        type = "titles"
+        super(type, options)
+      end
+    end
+  end
+end

data/lib/ecfr/subscriptions_service/base.rb

@@ -0,0 +1,19 @@
+module Ecfr
+  module SubscriptionsService
+    class Base < Ecfr::Base
+      require_relative "status"
+
+      require_relative "subscription"
+
+      SERVICE_PATH = "/api/subscriptions"
+
+      def self.base_url
+        Ecfr.config.subscriptions_service_url || Ecfr.config.base_url
+      end
+
+      def self.service_name
+        "Subscriptions Service"
+      end
+    end
+  end
+end

data/lib/ecfr/subscriptions_service/status.rb

@@ -0,0 +1,7 @@
+module Ecfr
+  module SubscriptionsService
+    class Status < Base
+      include DefaultStatusSetup
+    end
+  end
+end

data/lib/ecfr/subscriptions_service/subscription.rb

@@ -0,0 +1,97 @@
+module Ecfr
+  module SubscriptionsService
+    class Subscription < Base
+      result_key :subscriptions
+
+      attribute :title,
+        desc: "a description of the subscription"
+
+      attribute :delivery_count,
+        type: :integer,
+        desc: "the number of times the subscription has been delivered"
+      attribute :id,
+        type: :integer,
+        desc: "the subscription id"
+
+      attribute :created_at,
+        type: :date,
+        desc: "date the subscription was created"
+      attribute :last_delivered_at,
+        type: :date,
+        desc: "last date this subscription had matches and was delivered"
+
+      # TODO: upgrade to a class
+
+      # @return [Hash] with "query", and "hierarchy" keys
+      attribute :parameters,
+        desc: "the subscription search parameters"
+
+      SUBSCRIPTIONS_PATH = "v1/subscriptions"
+
+      #
+      # Retrive a list of subscriptions for a user
+      #
+      # @param [<Integer>] user_id id of user
+      #
+      # @return [[<Subscription>]] an array of subscriptions
+      #
+      def self.get_subscriptions(user_id)
+        perform(
+          :get,
+          "#{SUBSCRIPTIONS_PATH}/#{user_id}.json",
+          client_options: basic_auth_client_options
+        )
+      end
+
+      #
+      # Create a subscription for a user
+      #
+      # @param [<Integer>] user_id id of user
+      # @param [<Hash>] subscription_data arguments
+      #   required to create a subscription
+      # @option subscription_data [String] requesting_ip (required)
+      # @option subscription_data [Hash] search (required)
+      # @option subscription_data [String] search[:query] subscription search terms
+      # @option subscription_data [Ecfr::Common::Hierarchy] search[:hierarchy] hierarchy to limit subscription search
+      #
+      # @return [<Subscription>] the created subscription
+      #
+      def self.create_subscription(user_id, subscription_data)
+        perform(
+          :post,
+          "#{SUBSCRIPTIONS_PATH}/#{user_id}",
+          params: subscription_data,
+          client_options: basic_auth_client_options,
+          perform_options: {attributes_key: "subscription"}
+        )
+      end
+
+      #
+      # Delete a subscription
+      #
+      # @param [<Integer>] user_id id of user
+      # @param [<String>] token unique delete token
+      # @param [<String>] subscription_id id of subscription
+      #
+      # @return [[<Subscription>, <Integer>]] the deleted subscription and response code
+      #
+      def self.delete_subscription(user_id, token, subscription_id)
+        unsubscribe_data = {
+          token: token,
+          user_id: user_id,
+          subscription_id: subscription_id
+        }
+
+        subscription = perform(
+          :delete,
+          "#{SUBSCRIPTIONS_PATH}/unsubscribe",
+          params: unsubscribe_data,
+          client_options: basic_auth_client_options,
+          perform_options: {attributes_key: "subscription"}
+        )
+
+        [subscription, subscription.response_status]
+      end
+    end
+  end
+end

data/lib/ecfr/testing/extensions/admin_service/ecfr_correction_extensions.rb

@@ -0,0 +1,13 @@
+class Ecfr::AdminService::EcfrCorrection
+  extend ResponseHelper
+
+  def self.response_for(corrections)
+    results = {
+      ecfr_corrections: corrections.is_a?(Array) ? corrections : [corrections]
+    }.to_json
+
+    build(
+      response: stubbed_response(results)
+    )
+  end
+end

data/lib/ecfr/testing/extensions/admin_service/issue_extensions.rb

@@ -0,0 +1,13 @@
+class Ecfr::AdminService::Issue
+  extend ResponseHelper
+
+  def self.response_for(issues)
+    results = {
+      issues: issues.is_a?(Array) ? issues : [issues]
+    }.to_json
+
+    build(
+      response: stubbed_response(results)
+    )
+  end
+end

data/lib/ecfr/testing/extensions/renderer_service/origin_extensions.rb

@@ -0,0 +1,13 @@
+class Ecfr::RendererService::Origin
+  extend ResponseHelper
+
+  def self.response_for(origins)
+    results = {
+      origins: origins.is_a?(Array) ? origins : [origins]
+    }
+
+    build(
+      response: stubbed_response(results.to_json)
+    )
+  end
+end

data/lib/ecfr/testing/extensions/search_service/content_version_result_extensions.rb

@@ -0,0 +1,16 @@
+class Ecfr::SearchService::ContentVersion::Result
+  extend ResponseHelper
+
+  def self.response_for(content_versions)
+    content_versions = content_versions.is_a?(Array) ? content_versions : [content_versions]
+
+    results = {
+      results: content_versions,
+      meta: content_versions.first.fetch("meta", nil)
+    }.compact
+
+    build(
+      response: stubbed_response(results.to_json)
+    )
+  end
+end

data/lib/ecfr/testing/extensions/search_service/date_facet_extensions.rb

@@ -0,0 +1,13 @@
+class Ecfr::SearchService::DateFacet
+  extend ResponseHelper
+
+  def self.response_for(date_facets)
+    results = {
+      dates: date_facets
+    }.to_json
+
+    build(
+      response: stubbed_response(results)
+    )
+  end
+end

data/lib/ecfr/testing/extensions/versioner_service/ancestors_extensions.rb

@@ -0,0 +1,20 @@
+class Ecfr::VersionerService::Ancestors
+  extend ResponseHelper
+
+  def self.response_for(ancestors)
+    # ancestors can be a hash of attributes from the :ancestors factory,
+    # or one+ NodeSummary attribute hashes from the :node_summary
+    # factory
+    results = if ancestors.is_a?(Hash) && ancestors.key?("ancestors")
+      ancestors
+    else
+      {
+        ancestors: ancestors.is_a?(Array) ? ancestors : [ancestors]
+      }
+    end
+
+    build(
+      response: stubbed_response(results.to_json)
+    )
+  end
+end

data/lib/ecfr/testing/extensions/versioner_service/title_extenstions.rb

@@ -0,0 +1,16 @@
+class Ecfr::VersionerService::Title
+  extend ResponseHelper
+
+  def self.response_for(titles)
+    titles = titles.is_a?(Array) ? titles : [titles]
+
+    results = {
+      titles: titles,
+      meta: titles.first.fetch("meta", nil)
+    }.compact
+
+    build(
+      response: stubbed_response(results.to_json)
+    )
+  end
+end

data/lib/ecfr/testing/factories/admin_service/cfr_reference_factory.rb

@@ -0,0 +1,14 @@
+FactoryBot.define do
+  factory :cfr_reference, class: "Ecfr::AdminService::EcfrCorrection::CfrReference" do
+    skip_create
+
+    cfr_reference { "1 CFR 1" }
+    hierarchy {
+      ecfr_attribute_hash(:hierarchy, title: "1", part: "1")
+    }
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+  end
+end

data/lib/ecfr/testing/factories/admin_service/ecfr_correction_factory.rb

@@ -0,0 +1,31 @@
+FactoryBot.define do
+  factory :ecfr_correction, class: "Ecfr::AdminService::EcfrCorrection" do
+    skip_create
+
+    corrective_action { "corrected" }
+    fr_citation { "84 FR 12345" }
+
+    id { 1 }
+    position { 1 }
+    title { 1 }
+    year { correction_year }
+
+    error_corrected { Date.parse("#{year}-03-03") }
+    error_occurred { Date.parse("#{year}-01-01") }
+    last_modified { error_corrected }
+
+    cfr_references {
+      [ecfr_attribute_hash(:cfr_reference)]
+    }
+
+    display_in_toc { false }
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+
+    transient do
+      correction_year { 2017 }
+    end
+  end
+end

data/lib/ecfr/testing/factories/admin_service/issue_change_factory.rb

@@ -0,0 +1,12 @@
+FactoryBot.define do
+  factory :issue_change, class: "Ecfr::AdminService::Issue::Change" do
+    skip_create
+
+    change_description { "5 CFR 123" }
+    change_type { :effective }
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+  end
+end

data/lib/ecfr/testing/factories/admin_service/issue_factory.rb

@@ -0,0 +1,21 @@
+FactoryBot.define do
+  factory :issue, class: "Ecfr::AdminService::Issue" do
+    skip_create
+
+    description { "January 1, 2019" }
+
+    titles { [5, 7, 9] }
+
+    end_date { "2019-01-01" }
+    issue_date { "2019-01-01" }
+    start_date { "2019-01-01" }
+
+    changes {
+      [ecfr_attribute_hash(:issue_change)]
+    }
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+  end
+end

data/lib/ecfr/testing/factories/common/hierarchy_factory.rb

@@ -0,0 +1,36 @@
+FactoryBot.define do
+  factory :hierarchy, class: "Ecfr::Common::Hierarchy" do
+    skip_create
+
+    title { nil }
+    subtitle { nil }
+    chapter { nil }
+    subchapter { nil }
+    part { nil }
+    subpart { nil }
+    subject_group { nil }
+    section { nil }
+    appendix { nil }
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+
+    trait :with_defaults do
+      title { "1" }
+      subtitle { "A" }
+      chapter { "I" }
+      subchapter { "I" }
+      part { "1" }
+      subpart { "B" }
+      subject_group { nil }
+      section { "1.1" }
+      appendix { nil }
+    end
+
+    trait :appendix do
+      section { nil }
+      appendix { "Appendix A to Part 1" }
+    end
+  end
+end

data/lib/ecfr/testing/factories/renderer_service/origin_factory.rb

@@ -0,0 +1,32 @@
+FactoryBot.define do
+  factory :origin, class: "Ecfr::RendererService::Origin" do
+    skip_create
+
+    identifier { "121" }
+    label_level { "Part 121" }
+    level { "part" }
+    link { "/current/title-40/part-121" }
+    title { "Part 121" }
+
+    authority {
+      ["Sec. 21 (b) and (c), 84 Stat. 91 (<a href=\"https://www.govinfo.gov/link/uscode/33/1171\" class=\"usc external\" target=\"_blank\" rel=\"noopener noreferrer\">33 U.S.C. 1171(b)</a> (1970)); Reorganization Plan No. 3 of 1970. "]
+    }
+    source {
+      ["<a href=\"https://www.federalregister.gov/citation/36-FR-22487\" class=\"fr-reference\" data-reference=\"36 FR 22487\">36 FR 22487</a>, Nov. 25, 1971, unless otherwise noted. Redesignated at <a href=\"https://www.federalregister.gov/citation/37-FR-21441\" class=\"fr-reference\" data-reference=\"37 FR 21441\">37 FR 21441</a>, Oct. 11, 1972, and further redesignated at <a href=\"https://www.federalregister.gov/citation/44-FR-32899\" class=\"fr-reference\" data-reference=\"44 FR 32899\">44 FR 32899</a>, June 7, 1979. "]
+    }
+
+    current { false }
+
+    hierarchy {
+      ecfr_attribute_hash(:hierarchy,
+        title: "40",
+        chapter: "I",
+        subchapter: "D",
+        part: "121")
+    }
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+  end
+end

data/lib/ecfr/testing/factories/search_service/content_version_count_factory.rb

@@ -0,0 +1,20 @@
+FactoryBot.define do
+  factory :content_version_count, class: "Ecfr::SearchService::ContentVersion::Count" do
+    skip_create
+
+    meta {
+      {
+        description: "Description of results...",
+        total_count: total_count
+      }
+    }
+
+    transient do
+      total_count { 10 }
+    end
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+  end
+end

data/lib/ecfr/testing/factories/search_service/content_version_result_factory.rb

@@ -0,0 +1,76 @@
+FactoryBot.define do
+  factory :content_version_result, class: "Ecfr::SearchService::ContentVersion::Result" do
+    skip_create
+
+    change_types { [] }
+
+    full_text_excerpt {
+      "Section 100.100 full text excerpt with <strong>formatting</strong>"
+    }
+
+    hierarchy {
+      {
+        title: "10",
+        subtitle: "B",
+        chapter: "II",
+        subchapter: "H",
+        part: "100",
+        subpart: "D",
+        subject_group: nil,
+        section: (type == "Section") ? "100.100" : nil,
+        appendix: (type == "Appendix") ? "Appendix A to Subpart D of Part 100" : nil
+      }
+    }
+
+    # defaults for these are generated in helpers based on the hierarchy
+    # provided - any provided here will override just those keys
+    headings { {} }
+    hierarchy_headings { {} }
+
+    reserved { false }
+    removed { false }
+
+    score { 16.946056 }
+    structure_index { 1 }
+
+    starts_on { "2017-01-03" }
+    ends_on { nil }
+
+    type { "Section" }
+
+    trait :appendix do
+      type { "Appendix" }
+    end
+
+    meta {
+      {
+        current_page: current_page,
+        description: description,
+        min_date: min_date,
+        max_date: max_date,
+        max_score: max_score,
+        total_count: total_count,
+        total_pages: total_pages
+      }
+    }
+
+    transient do
+      current_page { 1 }
+      description { "Results for search terms x, y, and z" }
+      min_date { "2017-01-03" }
+      max_date { "2017-01-10" }
+      max_score { 1 }
+      total_count { 1 }
+      total_pages { 1 }
+    end
+
+    initialize_with {
+      attrs = FactoryBotHelpers::EcfrGemInitializeHelpers.pre_initialize_attrs_for(
+        :content_version_result,
+        attributes
+      )
+
+      new(attrs.deep_stringify_keys)
+    }
+  end
+end