openstax_cnx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1290e2c41b0cfe6e5f18b3a8d2f5f423d1ecec4d661b589929514a790064683d
+  data.tar.gz: b86557dc8226f2179fcb21990bdc5b6a2c796308943b4aa9eca71a932b258e95
+SHA512:
+  metadata.gz: f704b248e1e7f1710ff6d75af6595171437279131f3f478cd6305ae7797578ce67026b56a8ea37ce4349b63b34023cd1ce9db909d39f51c3725cccf315bdc031
+  data.tar.gz: 2139b21f10a4157e532ca4e92ed071cb2aa4cc3df0a1d7eff86f43e8033d1d07f542b1b36114b43f9acf7892566bc022514467e3c3b74729844059d13b7b3e14

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.env
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jpslav@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in openstax_cnx.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    openstax_cnx (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (11.0.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    dotenv (2.7.2)
+    hashdiff (0.3.8)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  dotenv
+  openstax_cnx!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 JP Slavinsky
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# OpenStax::Cnx
+
+This gem provides a Ruby interface to OpenStax book content.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openstax_cnx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openstax_cnx
+
+## Usage
+
+Books are made up of BookParts and Pages.  Every Book as a single top-level "root" BookPart.  BookParts can contain other BookParts and Pages.  Many OpenStax books are organized as pages within chapters.  For these books the Ruby objects hierarchy looks like:
+
+```
+Book
+  BookPart (the "root")
+    Page (the "Preface")
+    BookPart (Chapter 1)
+      Page (Introduction)
+      Page (Section 1.1)
+      etc...
+    BookPart (Chapter 2)
+      Page (Introduction)
+      etc...
+    etc...
+```
+
+Some OpenStax books organized chapters into units.  The units are BookParts like the chapters are:
+
+```
+Book
+  BookPart (the "root")
+    Page (the "Preface")
+    BookPart (Unit 1)
+      Page (Unit Introduction)
+      BookPart (Chapter 1)
+        Page (Introduction)
+        Page (Section 1.1)
+        etc...
+      BookPart (Chapter 2)
+        Page (Introduction)
+        etc...
+      etc...
+    BookPart (Unit 2)
+      etc ...
+```
+
+This gem gives you Ruby objects to navigate this hierarchy and access the metadata and content at each level.  You start by creating a `Book` object given that book's UUID.
+
+```ruby
+book = OpenStax::Cnx::V1.book(id: "031da8d3-b525-429c-80cf-6c8ed997733a")
+```
+
+Books have some metadata you can read out:
+
+```ruby
+book.title # => "College Physics"
+book.baked # => "2019-03-20T14:24:26.164476-05:00"
+book.url   # => "https://archive.cnx.org/contents/031da8d3-b525-429c-80cf-6c8ed997733a"
+```
+
+To dig deeper, get the `root_book_part` and then is `parts`
+
+```ruby
+book.root_book_part.is_root # => true
+book.root_book_part.parts.count # => 40
+book.root_book_part.parts.first.class # => OpenStax::Cnx::V1::Page
+book.root_book_part.parts.first.title # => "Preface"
+book.root_book_part.parts[2].class # => OpenStax::Cnx::V1::BookPart
+book.root_book_part.parts[2].title # => "Kinematics"
+book.root_book_part.parts[2].is_chapter? # => true
+book.root_book_part.parts[2].parts.count # => 13
+book.root_book_part.parts[2].parts[6].class # => OpenStax::Cnx::V1::Page
+book.root_book_part.parts[2].parts[6].title # => "Problem-Solving Basics for One-Dimensional Kinematics"
+book.root_book_part.parts[2].parts[6].baked_book_location # => ["2", "6"]
+book.root_book_part.parts[2].parts[6].parsed_title # => {:text=>"Problem-Solving Basics for One-Dimensional Kinematics", :book_location=>["2", "6"]}
+```
+
+Note that a BookPart's parts array can contain both Pages and BookParts.  The baked book location is the section number, e.g. above we see section 2.6.
+
+You can run the above commands using the `bin/console` command in the gem directory.
+
+### Configuration
+
+You can override default gem configurations with the following:
+
+```ruby
+OpenStax::Cnx::V1.configure do |config|
+  # where to get the book content
+  config.archive_url_base = "https://someurl.com" # default is "https://archive.cnx.org"
+  # whether to ignore the book version history
+  config.ignore_history = false # default is true
+  # a logger
+  config.logger = Rails.logger # default is a null logger
+end
+```
+
+You can temporarily override the Archive URL with:
+
+```ruby
+OpenStax::Cnx::V1.with_archive_url("https://archive-staging.cnx.org") do
+  # your code here, will see the archive-staging url
+end
+# the original archive URL will be reset by this point
+```
+
+This is useful in tests where the content may not be on the production system.
+
+### What is `V1`?
+
+The versions in this gem (e.g. the `V1` in `OpenStax::Cnx::V1::Book`) are not versions of the CNX API, but rather just different ways of building models to access the CNX API.  We made a `V1` so that we could wildly change our mind later and add a `V2` without impact `V1` clients.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openstax_cnx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OpenstaxCnx project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/openstax_cnx/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openstax_cnx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/openstax/cnx/v1.rb

@@ -0,0 +1,134 @@
+require 'addressable/uri'
+require 'open-uri'
+require 'logger'
+require 'nokogiri'
+require 'json'
+
+require_relative './v1/http_error'
+
+require_relative './v1/book'
+require_relative './v1/book_part'
+require_relative './v1/page'
+require_relative './v1/baked'
+
+module OpenStax::Cnx::V1
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class NullLogger < Logger
+    def initialize(*args); end
+    def add(*args, &block); end
+  end
+
+  class Configuration
+    attr_reader :archive_url_base
+    attr_reader :webview_url_base
+    attr_accessor :ignore_history
+    attr_accessor :logger
+
+    def initialize
+      @logger = OpenStax::Cnx::V1::NullLogger.new
+      @ignore_history = true
+      self.archive_url_base = "https://archive.cnx.org"
+    end
+
+    def archive_url_base=(url)
+      uri = Addressable::URI.parse(url)
+      raise "Invalid CNX archive URL: #{url}" if uri.nil? || uri.host.nil?
+
+      uri.scheme = 'https'
+      @archive_url_base = uri.to_s
+
+      uri.host = uri.host.sub(/archive[\.-]?/, '')
+      @webview_url_base = uri.to_s
+    end
+
+    def webview_url_base=(url)
+      uri = Addressable::URI.parse(url)
+      raise "Invalid CNX webview URL: #{url}" if uri.nil? || uri.host.nil?
+
+      uri.scheme = 'https'
+      @webview_url_base = uri.to_s
+
+      uri.host = "archive-#{uri.host}".sub('archive-cnx', 'archive.cnx')
+      @archive_url_base = uri.to_s
+    end
+
+  end
+
+  class << self
+
+    def new_configuration
+      OpenStax::Cnx::V1::Configuration.new
+    end
+
+    def archive_url_base
+      configuration.archive_url_base
+    end
+
+    def webview_url_base
+      configuration.webview_url_base
+    end
+
+    def logger
+      configuration.logger
+    end
+
+    def with_archive_url(url)
+      begin
+        old_url = archive_url_base
+        self.configuration.archive_url_base = url
+
+        yield
+      ensure
+        self.configuration.archive_url_base = old_url
+      end
+    end
+
+    def with_webview_url(url)
+      begin
+        old_url = webview_url_base
+        self.configuration.webview_url_base = url
+
+        yield
+      ensure
+        self.configuration.webview_url_base = old_url
+      end
+    end
+
+    # Archive url for the given path
+    # Forces /contents/ to be prepended to the path, unless the path begins with /
+    def archive_url_for(path)
+      Addressable::URI.join(configuration.archive_url_base, '/contents/', path).to_s
+    end
+
+    # Webview url for the given path
+    # Forces /contents/ to be prepended to the path, unless the path begins with /
+    def webview_url_for(path)
+      Addressable::URI.join(configuration.webview_url_base, '/contents/', path).to_s
+    end
+
+    def fetch(url)
+      begin
+        OpenStax::Cnx::V1.logger.debug { "Fetching #{url}" }
+        data = JSON.parse open(url, 'ACCEPT' => 'text/json').read
+        data.delete("history") if configuration.ignore_history
+        data
+      rescue OpenURI::HTTPError => exception
+        raise OpenStax::HTTPError, "#{exception.message} for URL #{url}"
+      end
+    end
+
+    def book(options = {})
+      OpenStax::Cnx::V1::Book.new(options)
+    end
+
+  end
+
+end

data/lib/openstax/cnx/v1/baked.rb

@@ -0,0 +1,13 @@
+module OpenStax::Cnx::V1::Baked
+  def self.parse_title(title)
+    return nil if title.nil?
+
+    part = Nokogiri::HTML.fragment(title)
+    text_node = part.css('.os-text')
+    if !text_node.empty?
+      { text: text_node.text, book_location: part.css('.os-number').text.split('.') }
+    else
+      { text: title, book_location: [] }
+    end
+  end
+end

data/lib/openstax/cnx/v1/book.rb

@@ -0,0 +1,59 @@
+module OpenStax::Cnx::V1
+  class Book
+
+    def initialize(id: nil, hash: nil, title: nil, tree: nil, root_book_part: nil)
+      @id             = id
+      @hash           = hash
+      @title          = title
+      @tree           = tree
+      @root_book_part = root_book_part
+    end
+
+    attr_reader :id
+
+    def url
+      @url ||= OpenStax::Cnx::V1.archive_url_for(id)
+    end
+
+    def baked
+      @baked ||= hash.fetch('baked', nil)
+    end
+
+    def collated
+      @collated ||= hash.fetch('collated', nil)
+    end
+
+    def hash
+      @hash ||= OpenStax::Cnx::V1.fetch(url)
+    end
+
+    def uuid
+      @uuid ||= hash.fetch('id') { |key| raise "Book id=#{@id} is missing #{key}" }
+    end
+
+    def short_id
+      @short_id ||= hash.fetch('shortId', nil)
+    end
+
+    def version
+      @version ||= hash.fetch('version') { |key| raise "Book id=#{@id} is missing #{key}" }
+    end
+
+    def canonical_url
+      @canonical_url ||= OpenStax::Cnx::V1.archive_url_for("#{uuid}@#{version}")
+    end
+
+    def title
+      @title ||= hash.fetch('title') { |key| raise "Book id=#{@id} is missing #{key}" }
+    end
+
+    def tree
+      @tree ||= hash.fetch('tree') { |key| raise "Book id=#{@id} is missing #{key}" }
+    end
+
+    def root_book_part
+      @root_book_part ||= BookPart.new(hash: tree, is_root: true, book: self)
+    end
+
+  end
+end

data/lib/openstax/cnx/v1/book_part.rb

@@ -0,0 +1,48 @@
+module OpenStax::Cnx::V1
+  class BookPart
+
+    def initialize(hash: {}, is_root: false, book: nil)
+      @hash = hash
+      @is_root = is_root
+      @book = book
+    end
+
+    attr_reader :hash, :is_root, :book
+
+    def parsed_title
+      @parsed_title ||= OpenStax::Cnx::V1::Baked.parse_title(
+        hash.fetch('title') { |key| raise "#{self.class.name} id=#{@id} is missing #{key}" }
+      )
+    end
+
+    def baked_book_location
+      @baked_book_location ||= parsed_title[:book_location]
+    end
+
+    def title
+      @title ||= parsed_title[:text]
+    end
+
+    def contents
+      @contents ||= hash.fetch('contents') do |key|
+        raise "#{self.class.name} id=#{@id} is missing #{key}"
+      end
+    end
+
+    def parts
+      @parts ||= contents.map do |hash|
+        if hash.has_key? 'contents'
+          self.class.new(hash: hash, book: book)
+        else
+          OpenStax::Cnx::V1::Page.new(hash: hash, book: book)
+        end
+      end
+    end
+
+    def is_chapter?
+      # A BookPart is a chapter if none of its children are BookParts
+      @is_chapter ||= parts.none? { |part| part.is_a?(self.class) }
+    end
+
+  end
+end

data/lib/openstax/cnx/v1/http_error.rb

@@ -0,0 +1,3 @@
+module OpenStax
+  class HTTPError < StandardError; end
+end

data/lib/openstax/cnx/v1/page.rb

@@ -0,0 +1,198 @@
+module OpenStax::Cnx::V1
+  class Page
+
+    # Start parsing here
+    ROOT_CSS = 'html > body'
+
+    # Find nodes that define relevant tags
+    LO_DEF_NODE_CSS = '.ost-learning-objective-def'
+    STD_DEF_NODE_CSS = '.ost-standards-def'
+    TEKS_DEF_NODE_CSS = '.ost-standards-teks'
+    APBIO_DEF_NODE_CSS = '.ost-standards-apbio'
+
+    STD_NAME_NODE_CSS = '.ost-standards-name'
+    STD_DESC_NODE_CSS = '.ost-standards-description'
+
+    # Find specific tags and extract the relevant parts
+    LO_REGEX = /ost-tag-lo-([\w+-]+)/
+    STD_REGEX = /ost-tag-std-([\w+-]+)/
+    TEKS_REGEX = /ost-tag-(teks-[\w+-]+)/
+
+    def self.feature_node(node, feature_ids)
+      feature_ids = [feature_ids].flatten
+      return if feature_ids.empty?
+
+      feature_id_css = feature_ids.map { |feature_id| "##{feature_id}" }.join(', ')
+      node.at_css(feature_id_css)
+    end
+
+    def initialize(hash: {}, id: nil, url: nil, title: nil, content: nil, book: nil)
+      @hash         = hash
+      @id           = id
+      @url          = url
+      @parsed_title = OpenStax::Cnx::V1::Baked.parse_title(title)
+      @content      = content
+      @book         = book
+    end
+
+    attr_accessor :chapter_section
+    attr_reader :hash, :book
+
+    def id
+      @id ||= hash.fetch('id') { |key| raise "Page is missing #{key}" }
+    end
+
+    def url
+      @url ||= url_for(id)
+    end
+
+    def parsed_title
+      @parsed_title ||= OpenStax::Cnx::V1::Baked.parse_title(
+        hash.fetch('title') { |key| raise "#{self.class.name} id=#{@id} is missing #{key}" }
+      )
+    end
+
+    def baked_book_location
+      parsed_title[:book_location]
+    end
+
+    def title
+      parsed_title[:text]
+    end
+
+    def is_intro?
+      return @is_intro unless @is_intro.nil?
+      # CNX plans to implement a better way to identify chapter intro pages
+      # This is a hack to be used until that happens
+      @is_intro = title.start_with?('Introduction')
+    end
+
+    def full_hash
+      @full_hash ||= OpenStax::Cnx::V1.fetch(url)
+    end
+
+    def uuid
+      @uuid ||= full_hash.fetch('id') { |key| raise "Book id=#{@id} is missing #{key}" }
+    end
+
+    def short_id
+      @short_id ||= full_hash.fetch('shortId', nil)
+    end
+
+    def version
+      @version ||= full_hash.fetch('version') { |key| raise "Book id=#{@id} is missing #{key}" }
+    end
+
+    def canonical_url
+      @canonical_url ||= url_for("#{uuid}@#{version}")
+    end
+
+    def content
+      @content ||= full_hash.fetch('content') { |key| raise "Page id=#{@id} is missing #{key}" }
+    end
+
+    def doc
+      @doc ||= Nokogiri::HTML(content)
+    end
+
+    def root
+      @root ||= doc.at_css(ROOT_CSS)
+    end
+
+    def los
+      @los ||= tags.select{ |tag| tag[:type] == :lo }.map{ |tag| tag[:value] }
+    end
+
+    def aplos
+      @aplos ||= tags.select{ |tag| tag[:type] == :aplo }.map{ |tag| tag[:value] }
+    end
+
+    def tags
+      return @tags.values unless @tags.nil?
+
+      # Start with default cnxmod tag
+      cnxmod_value = "context-cnxmod:#{uuid}"
+      @tags = { cnxmod_value => { value: cnxmod_value, type: :cnxmod } }
+
+      # Extract tag name and description from .ost-standards-def and .os-learning-objective-def.
+
+      # LO tags
+      root.css(LO_DEF_NODE_CSS).each do |node|
+        klass = node.attr('class')
+        lo_value = LO_REGEX.match(klass).try(:[], 1)
+        next if lo_value.nil?
+
+        teks_value = TEKS_REGEX.match(klass).try(:[], 1)
+        description = node.content.strip
+
+        @tags[lo_value] = {
+          value: lo_value,
+          description: description,
+          teks: teks_value,
+          type: :lo
+        }
+      end
+
+      # Other standards
+      root.css(STD_DEF_NODE_CSS).each do |node|
+        klass = node.attr('class')
+        name = node.at_css(STD_NAME_NODE_CSS).try(:content).try(:strip)
+        description = node.at_css(STD_DESC_NODE_CSS).try(:content).try(:strip)
+        value = nil
+
+        if node.matches?(TEKS_DEF_NODE_CSS)
+          value = TEKS_REGEX.match(klass).try(:[], 1)
+          type = :teks
+        elsif node.matches?(APBIO_DEF_NODE_CSS)
+          value = LO_REGEX.match(klass).try(:[], 1)
+          type = :aplo
+        end
+
+        next if value.nil?
+
+        @tags[value] = {
+          value: value,
+          name: name,
+          description: description,
+          type: type
+        }
+      end
+
+      @tags.values
+    end
+
+    protected
+
+    def url_for(path)
+      book.nil? ? OpenStax::Cnx::V1.archive_url_for(path) : "#{book.canonical_url}:#{path}"
+    end
+
+    # add container div around note content for styling
+    def map_note_format(node)
+      note_selector = <<-eos
+        .note:not(.learning-objectives),
+        .example,
+        .grasp-check,
+        [data-type="note"],
+        [data-element-type="check-understanding"]
+      eos
+
+      note_selector = note_selector.gsub(/\s+/, "")
+
+      node.css(note_selector).each do |note|
+        note.set_attribute('data-tutor-transform', true)
+        body = Nokogiri::XML::Node.new('div', doc)
+        body.set_attribute('data-type', 'content')
+
+        content = note.css('>*:not([data-type=title])')
+        content.unlink()
+
+        body.children = content
+        note.add_child(body)
+      end
+
+      node
+    end
+
+  end
+end

data/lib/openstax/cnx/version.rb

@@ -0,0 +1,5 @@
+module OpenStax
+  module Cnx
+    VERSION = "0.1.0"
+  end
+end

data/lib/openstax_cnx.rb

@@ -0,0 +1,8 @@
+module OpenStax
+  module Cnx
+    module V1; end
+  end
+end
+
+require "openstax/cnx/version"
+require "openstax/cnx/v1"

data/openstax_cnx.gemspec

@@ -0,0 +1,48 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openstax/cnx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openstax_cnx"
+  spec.version       = OpenStax::Cnx::VERSION
+  spec.authors       = ["JP Slavinsky"]
+  spec.email         = ["jps@rice.edu"]
+
+  spec.summary       = %q{Bindings to fetch and inspect CNX books}
+  spec.description   = %q{Bindings to fetch and inspect CNX books}
+  spec.homepage      = "https://github.com/openstax/cnx-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/openstax/cnx-ruby"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: openstax_cnx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JP Slavinsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: vcr
+  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: byebug
+  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: Bindings to fetch and inspect CNX books
+email:
+- jps@rice.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openstax/cnx/v1.rb
+- lib/openstax/cnx/v1/baked.rb
+- lib/openstax/cnx/v1/book.rb
+- lib/openstax/cnx/v1/book_part.rb
+- lib/openstax/cnx/v1/http_error.rb
+- lib/openstax/cnx/v1/page.rb
+- lib/openstax/cnx/version.rb
+- lib/openstax_cnx.rb
+- openstax_cnx.gemspec
+homepage: https://github.com/openstax/cnx-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/openstax/cnx-ruby
+  source_code_uri: https://github.com/openstax/cnx-ruby
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Bindings to fetch and inspect CNX books
+test_files: []