openstax_content 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438e6037471accd85a41ff64543ef625e22d670121b1491eaa6c4d3827f4228b
-  data.tar.gz: 91b8fb852646355aad1c892e9a1fbfd0d54f3fd03ac5c4a286239ae10f51a710
+  metadata.gz: 578cf5b445c79d9e7dd1a904da90cb3daf527d2d8b7de128d07640e15d8bd066
+  data.tar.gz: b2bfe3524398a047b6722a047aa245de8ed52d02e4c9c37ca28f0b36840ba081
 SHA512:
-  metadata.gz: 5c73997fedc8f642bbcda603fac97e1c071710464117f2de9ad4d2ef7cb648df4edcd0a71da2895442f196ad214dbdd3c7bc8a43e4aba2549bf2d97832a59a8a
-  data.tar.gz: e73e524ac9ea295f635b9388aae5e73ec06a7e514ee74bf555f46df4d9a45af3d38baa1be12fdcef7c5c9c7ad77d5d036e09a289bb62c08ada89c5575a12419b
+  metadata.gz: c2f7708cce0fb71727d985dcef91f6b0844f1b3ba2b134a55cc6f4eb3bddf0132c633cce04ed8221d16f8aac785a08f1ef16fe17e6f184c7f481c479054e496b
+  data.tar.gz: 07bd028f00e935ef240585da56b2fd88e82959da61213787f03421e1f07c0afecb8f3257b9b269ff1affea5483a227f70d299e1782a528e7ebb1c4d96dd2dd6b

data/README.md

@@ -1,2 +1,100 @@
+[![Tests](https://github.com/openstax/content-ruby/workflows/Tests/badge.svg)](https://github.com/openstax/content-ruby/actions/workflows/tests.yml)
+
 # content-ruby
 Ruby bindings to read and parse the OpenStax ABL and the content archive
+
+## Installation
+Add this gem to your Gemfile and then add the following configuration to your boot
+(for example, in a Rails initializer):
+
+```rb
+OpenStax::Content.configure do |config|
+  config.abl_url = ENV['OPENSTAX_CONTENT_ABL_URL']
+  config.archive_path = ENV['OPENSTAX_CONTENT_ARCHIVE_PATH']
+  config.bucket_name = ENV['OPENSTAX_CONTENT_BUCKET_NAME']
+  config.domain = ENV['OPENSTAX_CONTENT_DOMAIN']
+  config.exercises_search_api_url = ENV['OPENSTAX_CONTENT_EXERCISES_SEARCH_API_URL']
+  config.logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+  config.s3_region = ENV['OPENSTAX_CONTENT_S3_REGION']
+  config.s3_access_key_id = ENV['OPENSTAX_CONTENT_S3_ACCESS_KEY_ID']
+  config.s3_secret_access_key = ENV['OPENSTAX_CONTENT_S3_SECRET_ACCESS_KEY']
+end
+```
+
+It's probably a good idea to read these values from environment variables
+s3_access_key_id and s3_secret_access_key are optional (you can use AWS instance roles instead)
+
+## Usage
+
+### Approved Book List (to get approved books and approved versions)
+```rb
+abl = OpenStax::Content::Abl.new
+approved_books = abl.approved_books
+approved_versions = abl.approved_versions
+```
+
+### S3 Bucket Listing (to get latest archive and book versions)
+```rb
+s3 = OpenStax::Content::S3.new
+if s3.bucket_configured?
+  latest_archive_version = s3.ls.last
+  latest_book_ids = s3.ls latest_archive_version
+  chosen_book = latest_book_ids.sample
+  book_uuid, book_version = chosen_book.split('@', 2)
+  book = OpenStax::Content::Book.new(
+    archive_version: latest_archive_version, uuid: book_uuid, version: book_version
+  )
+end
+```
+
+### Archive (to create archive links, load content and get book and page slugs)
+```rb
+archive = OpenStax::Content::Archive.new latest_archive_version
+
+book_id = "#{book_uuid}@#{book_version}"
+page_id = "#{book_id}:#{page_uuid}"
+
+book_url = archive.url_for book_id
+page_url = archive.url_for page_id
+
+book_json = archive.fetch book_id
+page_json = archive.fetch page_id
+
+book_hash = archive.json book_id
+page_hash = archive.json page_id
+
+book_slug = archive.slug book_id # or book_uuid
+page_slug = archive.slug page_id # or "#{book_uuid}:#{page_uuid}"
+```
+
+### Fragment Splitter (to split pages and create interactive readings)
+```rb
+fragment_splitter = OpenStax::Content::FragmentSplitter.new(
+  book.reading_processing_instructions, reference_view_url
+)
+fragment_splitter.split_into_fragments page.root
+```
+
+## Testing
+
+To run all existing tests for this gem, simply execute the following from the main folder:
+
+```sh
+$ rake
+```
+
+## Contributing
+
+1. Fork the openstax/content-ruby repo on Github
+2. Create a feature or bugfix branch (`git checkout -b my-new-feature`)
+3. Write tests for the feature/bugfix
+4. Implement the new feature/bugfix
+5. Make sure both new and old tests pass (`rake`)
+6. Commit your changes (`git commit -am 'Added some feature'`)
+7. Push the branch (`git push origin my-new-feature`)
+8. Create a new Pull Request to openstax/content-ruby on Github
+
+## License
+
+This gem is distributed under the terms of the AGPLv3 license.
+See the LICENSE file for details.

data/lib/openstax/content/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Content
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/lib/{openstax/content.rb → openstax_content.rb}

@@ -11,4 +11,4 @@ module OpenStax
   end
 end
 
-Dir["#{__dir__}/content/**/*.rb"].each { |file| require file }
+Dir["#{__dir__}/openstax/content/**/*.rb"].each { |file| require file }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_content
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dante Soares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !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'
 description: Ruby bindings to read and parse the OpenStax ABL and the content archive
 email:
 - dante.m.soares@rice.edu
@@ -117,7 +145,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/openstax/content.rb
 - lib/openstax/content/abl.rb
 - lib/openstax/content/archive.rb
 - lib/openstax/content/book.rb
@@ -136,6 +163,7 @@ files:
 - lib/openstax/content/s3.rb
 - lib/openstax/content/title.rb
 - lib/openstax/content/version.rb
+- lib/openstax_content.rb
 homepage: https://github.com/openstax/content-ruby
 licenses:
 - AGPL-3.0