openstax_content 0.3.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aebb8f3f720b66d54a35964a2c7471a4c1791b1eddf3a79278fb42974c1b03b
-  data.tar.gz: 743c42fe074b7e8aabc47540785d53ff2dec03c0f3b40eb12f79f0624d1e0f9c
+  metadata.gz: 606de08c8e8a83ca196e43eef4d8159f4bddd9d94bf5a357af6e5e8109ed57ad
+  data.tar.gz: 4ef85c1b6bba83ef5a2605d76a8fc76fd3ce63dc80d84a3030a2f1943a56251d
 SHA512:
-  metadata.gz: af95d3a223033476027839a1c4d49e01a9e8d72c8be9185059d83dd13bf8544e79d291984eec3ac2473ff63850ddb45e1d5bca4a1bfc70d6e86fa99429db2c7f
-  data.tar.gz: 0eae65c706c57ef7a9e27125124972e62c8edaa77d22a9d16785ac2efcb6723693b1f18bc1c9ffdb82d699c6134bfa3453b1b491e6d7ccffc73df399e470aa11
+  metadata.gz: 6f994e45ad7f63e9d2ac8e2e143ef6b23a2688fee58c7de54a230cda84723bfa43eb1febeade0687e007d3453d1c970f7c4c6dad04cd75cee5ff0b9bc01003b2
+  data.tar.gz: 345ec56a1b9aecf201612f67ee3b283f22928afba02ec1ddeb2ad9f6e4243ab95f33049bb1f7892b570515538588c3a97859e4aa009f5f24038bf57fcf6aff0b

data/lib/openstax/content/abl.rb

@@ -1,13 +1,81 @@
+require_relative 'archive'
+require_relative 'book'
+
 class OpenStax::Content::Abl
-  def body
-    @body ||= JSON.parse(Faraday.get(OpenStax::Content.abl_url).body).deep_symbolize_keys
+  def initialize(url: nil)
+    @url = url
+  end
+
+  def url
+    @url ||= OpenStax::Content.abl_url
+  end
+
+  def body_string
+    @body_string ||= Faraday.get(url).body
   end
 
-  def approved_books
-    body[:approved_books]
+  def body_hash
+    @body_hash ||= JSON.parse(body_string, symbolize_names: true)
   end
 
-  def approved_versions
-    body[:approved_versions]
+  def digest
+    Digest::SHA256.hexdigest body_string
+  end
+
+  def latest_approved_version_by_collection_id(archive: OpenStax::Content::Archive.new)
+    {}.tap do |hash|
+      body_hash[:approved_versions].each do |version|
+        next if version[:min_code_version] > archive.version
+
+        existing_version = hash[version[:collection_id]]
+
+        next if !existing_version.nil? &&
+                (existing_version[:content_version].split('.').map(&:to_i) <=>
+                 version[:content_version].split('.').map(&:to_i)) >= 0
+
+        hash[version[:collection_id]] = version
+      end
+    end
+  end
+
+  def approved_books(archive: OpenStax::Content::Archive.new)
+    # Can be removed once we have no more CNX books
+    version_by_collection_id = latest_approved_version_by_collection_id(archive: archive)
+
+    body_hash[:approved_books].flat_map do |approved_book|
+      if approved_book[:versions].nil?
+        # CNX-hosted book
+        version = version_by_collection_id[approved_book[:collection_id]]
+
+        next [] if version.nil?
+
+        approved_book[:books].map do |book|
+          OpenStax::Content::Book.new(
+            archive: archive,
+            uuid: book[:uuid],
+            version: version[:content_version].sub('1.', ''),
+            slug: book[:slug],
+            style: approved_book[:style]
+          )
+        end
+      else
+        # Git-hosted book
+        approved_book[:versions].flat_map do |version|
+          next [] if version[:min_code_version] > archive.version
+
+          commit_metadata = version[:commit_metadata]
+
+          commit_metadata[:books].map do |book|
+            OpenStax::Content::Book.new(
+              archive: archive,
+              uuid: book[:uuid],
+              version: version[:commit_sha][0..6],
+              slug: book[:slug],
+              style: book[:style]
+            )
+          end
+        end
+      end
+    end
   end
 end

data/lib/openstax/content/archive.rb

@@ -2,14 +2,29 @@ require 'addressable/uri'
 require 'faraday'
 
 class OpenStax::Content::Archive
-  def initialize(version)
+  def initialize(version: nil)
     @version = version
     @slugs = {}
   end
 
+  def s3
+    @s3 ||= OpenStax::Content::S3.new
+  end
+
+  def versions
+    @versions ||= s3.ls.reverse
+  end
+
+  def version
+    @version || versions.first
+  end
+
+  def previous_version
+    versions[versions.index(version) + 1]
+  end
+
   def base_url
-    @base_url ||= "https://#{OpenStax::Content.domain}/#{
-                  OpenStax::Content.archive_path}/#{@version}"
+    @base_url ||= "https://#{OpenStax::Content.domain}/#{OpenStax::Content.archive_path}/#{version}"
   end
 
   def url_for(object)
@@ -72,20 +87,16 @@ class OpenStax::Content::Archive
     end
   end
 
-  def s3
-    @s3 ||= OpenStax::Content::S3.new
-  end
-
   def add_latest_book_version_if_missing(object)
     book_id, page_id = object.split(':', 2)
     book_uuid, book_version = book_id.split('@', 2)
     return object unless book_version.nil? && s3.bucket_configured?
 
-    s3.ls(@version).each do |book|
-      uuid, version = book.split('@')
-      next unless uuid == book_uuid
+    s3.ls(version).each do |book|
+      s3_uuid, s3_version = book.split('@')
+      next unless s3_uuid == book_uuid
 
-      book_version = version
+      book_version = s3_version
       break
     end
 

data/lib/openstax/content/book.rb

@@ -1,27 +1,18 @@
-require_relative 'archive'
 require_relative 'book_part'
 
 class OpenStax::Content::Book
-  def initialize(
-    archive_version:, uuid: nil, version: nil, hash: nil, title: nil, tree: nil, root_book_part: nil
-  )
-    @uuid            = uuid || (hash || {})['id']
-    raise ArgumentError, 'Either uuid or hash with id key is required' if @uuid.nil?
+  extend Forwardable
 
-    @version         = version || (hash || {})['version']
-    raise ArgumentError, 'Either version or hash with version key is required' if @version.nil?
+  attr_reader :archive, :uuid, :version, :slug, :style
 
-    @archive_version = archive_version
-    @hash            = hash
-    @title           = title
-    @tree            = tree
-    @root_book_part  = root_book_part
-  end
-
-  attr_reader :archive_version, :uuid, :version
-
-  def archive
-    @archive ||= OpenStax::Content::Archive.new archive_version
+  def initialize(archive:, uuid:, version:, url: nil, hash: nil, slug: nil, style: nil)
+    @archive = archive
+    @uuid = uuid
+    @version = version
+    @url = url
+    @hash = hash
+    @slug = slug
+    @style = style
   end
 
   def url
@@ -32,6 +23,10 @@ class OpenStax::Content::Book
     @url_fragment ||= url.chomp('.json')
   end
 
+  def hash
+    @hash ||= archive.json url
+  end
+
   def baked
     @baked ||= hash['baked']
   end
@@ -40,22 +35,10 @@ class OpenStax::Content::Book
     @collated ||= hash.fetch('collated', false)
   end
 
-  def hash
-    @hash ||= archive.json url
-  end
-
-  def uuid
-    @uuid ||= hash.fetch('id')
-  end
-
   def short_id
     @short_id ||= hash['shortId']
   end
 
-  def version
-    @version ||= hash.fetch('version')
-  end
-
   def title
     @title ||= hash.fetch('title')
   end
@@ -67,4 +50,6 @@ class OpenStax::Content::Book
   def root_book_part
     @root_book_part ||= OpenStax::Content::BookPart.new(hash: tree, is_root: true, book: self)
   end
+
+  def_delegator :root_book_part, :all_pages
 end

data/lib/openstax/content/book_part.rb

@@ -44,4 +44,10 @@ class OpenStax::Content::BookPart
       end
     end
   end
+
+  def all_pages
+    @all_pages ||= parts.flat_map do |part|
+      part.is_a?(OpenStax::Content::Page) ? [ part ] : part.all_pages
+    end
+  end
 end

data/lib/openstax/content/page.rb

@@ -32,7 +32,7 @@ class OpenStax::Content::Page
     node.at_css(feature_id_css)
   end
 
-  def initialize(book: nil, hash: {}, uuid: nil, url: nil, title: nil, content: nil)
+  def initialize(book: nil, hash: {}, uuid: nil, url: nil, title: nil, slug: nil, content: nil)
     @uuid    = uuid || hash['id']&.split('@', 2)&.first
     raise ArgumentError, 'Either uuid or hash with id key is required' if @uuid.nil?
 
@@ -40,11 +40,12 @@ class OpenStax::Content::Page
     @hash    = hash
     @url     = url
     @title   = title || hash['title']
+    @slug    = slug || hash['slug']
     @content = content
   end
 
   attr_accessor :chapter_section
-  attr_reader :uuid, :hash
+  attr_reader :uuid, :hash, :slug
 
   def book
     raise ArgumentError, 'Book was not specified' if @book.nil?

data/lib/openstax/content/s3.rb

@@ -1,12 +1,13 @@
 require 'aws-sdk-s3'
 
 class OpenStax::Content::S3
-  def initialize
+  def initialize(bucket_name: nil)
+    @bucket_name = bucket_name
     @ls = Hash.new { |hash, key| hash[key] = Hash.new { |hash, key| hash[key] = {} } }
   end
 
   def bucket_name
-    OpenStax::Content.bucket_name
+    @bucket_name ||= OpenStax::Content.bucket_name
   end
 
   def bucket_configured?

data/lib/openstax/content/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Content
-    VERSION = '0.3.0'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_content
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dante Soares
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.19
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Ruby bindings to read and parse the OpenStax ABL and the content archive