canlii 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 471bb65f4244f6dff6818d538d4d90b702437466a1484aeed6710aae9aee1821
+  data.tar.gz: a15b1f8ad672f1a9e8a5e69836dc073d9fb7ed02fdc2af987c88a80e5042c0e7
+SHA512:
+  metadata.gz: a0317eb6d7611e5d536f824904b30f3ba4613f6e12b4aefa3f7247e7fca0371abb609ee7295d2291860823e92cbc4ed9cc817433bd60c3bcdc5895fa4f3aab8e
+  data.tar.gz: 77ead1f2d01b5abb9447d771f2a095a007698a9a2885bccab6e24c0f5605b7058ae4eaa342943161d179a21e07c2208093a2d640b4e13c4e4c1b16f69ca7599c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-30
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ajay Krishnan
+
+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,119 @@
+# CanLII Ruby
+
+A lightweight Ruby client for accessing Canadian legal information via the CanLII API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canlii'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install canlii
+
+## Configuration
+
+### Basic Configuration
+
+```ruby
+require 'canlii'
+
+CanLII.configure do |config|
+  config.api_key = ENV["CANLII_API_KEY"]
+  config.logger = Logger.new(STDOUT)
+  config.timeout = 30 # Optional: timeout in seconds (default: 30)
+end
+```
+
+### Rails Configuration
+
+In `config/initializers/canlii.rb`:
+
+```ruby
+CanLII.configure do |config|
+  config.api_key = ENV["CANLII_API_KEY"]
+  config.logger = Rails.logger
+  config.timeout = 30 # Optional: timeout in seconds (default: 30)
+end
+```
+
+## Usage
+
+### List All Databases
+
+```ruby
+databases = CanLII::Database.all
+databases.each do |db|
+  puts "#{db.database_id}: #{db.name} (#{db.jurisdiction})"
+end
+```
+
+### Browse Cases
+
+```ruby
+# Recent Supreme Court cases
+cases = CanLII::Case.browse("csc-scc", limit: 10)
+cases.each do |c|
+  puts "#{c.citation}: #{c.title}"
+end
+
+# Cases from last 30 days
+recent = CanLII::Case.browse("onca", 
+  published_after: 30.days.ago,
+  limit: 100
+)
+```
+
+### Find Specific Case
+
+```ruby
+# Find returns nil if not found
+case_detail = CanLII::Case.find("csc-scc", "2024scc1")
+
+# Find! raises error if not found
+case_detail = CanLII::Case.find!("csc-scc", "2024scc1")
+```
+
+### Language Support
+
+```ruby
+# Temporary language switch
+CanLII.with_language("fr") do
+  databases = CanLII::Database.all  # Returns French names
+  cases = CanLII::Case.browse("qcca")  # Quebec cases
+end
+
+# Permanent language switch
+CanLII.configuration.language = "fr"
+```
+
+### Using Custom Clients (Advanced)
+
+```ruby
+# For testing or using multiple API keys
+mock_client = MyMockClient.new
+
+CanLII::Case.with_client(mock_client) do
+  case_detail = CanLII::Case.find("on", "2024onca1")
+  # This will use mock_client instead of the default HTTP client
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ajaynomics/canlii-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/canlii/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CanLII
+  class Base
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
+    class << self
+      def with_client(client = nil)
+        old_client = Thread.current[:canlii_client]
+
+        if client
+          Thread.current[:canlii_client] = client
+          yield client
+        else
+          CanLII.configuration.validate!
+          yield current_client
+        end
+      ensure
+        Thread.current[:canlii_client] = old_client
+      end
+
+      private
+
+      def current_client
+        Thread.current[:canlii_client] || Client.new
+      end
+    end
+  end
+end

data/lib/canlii/case.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module CanLII
+  class Case < Base
+    attribute :database_id, :string
+    attribute :case_id, :string
+    attribute :title, :string
+    attribute :citation, :string
+    attribute :url, :string
+    attribute :decision_date, :date
+    attribute :language, :string
+
+    class << self
+      def browse(database_id, **options)
+        with_client do |client|
+          params = build_browse_params(options)
+          response = client.get("/caseBrowse/#{language}/#{database_id}", params)
+
+          return [] if response.is_a?(Array)
+
+          cases = response["cases"] || []
+          cases.map { |data| new_from_browse(data) }
+        end
+      end
+
+      def find(database_id, case_id)
+        with_client do |client|
+          response = client.get("/caseBrowse/#{language}/#{database_id}/#{case_id}")
+          new_from_detail(response)
+        end
+      rescue NotFoundError
+        nil
+      end
+
+      def find!(database_id, case_id)
+        find(database_id, case_id) ||
+          raise(NotFoundError, "Case not found: #{database_id}/#{case_id}")
+      end
+
+      private
+
+      def new_from_browse(data)
+        case_id_obj = data["caseId"]
+        case_id_value = case_id_obj.is_a?(Hash) ? case_id_obj["en"] : case_id_obj
+
+        new(
+          database_id: data["databaseId"],
+          case_id: case_id_value,
+          title: data["title"],
+          citation: data["citation"],
+          decision_date: data["decisionDate"]
+        )
+      end
+
+      def new_from_detail(data)
+        new(
+          database_id: data["databaseId"],
+          case_id: data["caseId"],
+          title: data["title"],
+          citation: data["citation"],
+          url: data["url"],
+          decision_date: data["decisionDate"],
+          language: data["language"]
+        )
+      end
+
+      def build_browse_params(options)
+        params = {}
+        params[:offset] = options[:offset] || 0
+        params[:resultCount] = options[:limit] || 20
+
+        params[:decisionDateAfter] = options[:published_after].to_s if options[:published_after]
+
+        params[:decisionDateBefore] = options[:published_before].to_s if options[:published_before]
+
+        params
+      end
+
+      def language
+        CanLII.configuration.language
+      end
+    end
+
+    def to_s
+      citation || title || "#{database_id}/#{case_id}"
+    end
+  end
+end

data/lib/canlii/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module CanLII
+  class Client
+    def get(path, params = {})
+      params = params.merge(api_key: config.api_key, language: config.language)
+
+      http_client = HTTP
+      http_client = http_client.timeout(config.timeout) if config.timeout
+
+      response = http_client.get(build_url(path), params: params)
+      handle_response(response)
+    end
+
+    private
+
+    def build_url(path)
+      "#{config.base_url}#{path}"
+    end
+
+    def handle_response(response)
+      case response.status
+      when 200..299
+        JSON.parse(response.body.to_s)
+      when 401, 403
+        raise AuthenticationError, "Invalid API key"
+      when 404
+        raise NotFoundError, "Resource not found"
+      when 429
+        raise RateLimitError, "Rate limit exceeded"
+      when 500..599
+        raise ResponseError, "Server error: HTTP #{response.status}"
+      else
+        raise ResponseError, "HTTP #{response.status}: #{response.body}"
+      end
+    rescue HTTP::TimeoutError
+      raise TimeoutError, "Request timed out after #{config.timeout} seconds"
+    rescue HTTP::Error => e
+      raise ConnectionError, "Network error: #{e.message}"
+    rescue JSON::ParserError => e
+      raise ResponseError, "Invalid JSON response: #{e.message}"
+    end
+
+    def config
+      CanLII.configuration
+    end
+  end
+end

data/lib/canlii/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CanLII
+  class Configuration
+    attr_accessor :api_key, :base_url, :language, :logger, :timeout
+
+    def initialize
+      @base_url = "https://api.canlii.org/v1"
+      @language = "en"
+      @api_key = ENV.fetch("CANLII_API_KEY", nil)
+      @logger = Logger.new($stdout)
+      @timeout = 30 # Default 30 seconds
+    end
+
+    def validate!
+      raise Error, "API key is required" if api_key.nil? || api_key.to_s.strip.empty?
+    end
+  end
+end

data/lib/canlii/database.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CanLII
+  class Database < Base
+    attribute :database_id, :string
+    attribute :name, :string
+    attribute :jurisdiction, :string
+
+    class << self
+      def all
+        with_client do |client|
+          response = client.get("/caseBrowse/#{language}")
+          databases = response["caseDatabases"] || []
+
+          databases.map do |data|
+            new(
+              database_id: data["databaseId"],
+              name: data["name"],
+              jurisdiction: data["jurisdiction"]
+            )
+          end
+        end
+      end
+
+      private
+
+      def language
+        CanLII.configuration.language
+      end
+    end
+  end
+end

data/lib/canlii/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CanLII
+  # Base error class for all CanLII errors
+  class Error < StandardError; end
+
+  # Raised when API key is invalid or missing
+  class AuthenticationError < Error; end
+
+  # Raised when requested resource doesn't exist
+  class NotFoundError < Error; end
+
+  # Raised when API rate limit is exceeded
+  class RateLimitError < Error; end
+
+  # Raised when request times out
+  class TimeoutError < Error; end
+
+  # Raised when connection fails
+  class ConnectionError < Error; end
+
+  # Raised for other HTTP errors
+  class ResponseError < Error; end
+end

data/lib/canlii/rails/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CanLII
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "canlii.logger" do |_app|
+        CanLII.configuration.logger = ::Rails.logger
+      end
+    end
+  end
+end

data/lib/canlii/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CanLII
+  VERSION = "0.1.1"
+end

data/lib/canlii.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "active_model"
+require "http"
+require "json"
+require "logger"
+
+require_relative "canlii/version"
+require_relative "canlii/errors"
+require_relative "canlii/configuration"
+require_relative "canlii/client"
+require_relative "canlii/base"
+require_relative "canlii/database"
+require_relative "canlii/case"
+
+module CanLII
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def with_language(language)
+      old_language = configuration.language
+      configuration.language = language
+      yield
+    ensure
+      configuration.language = old_language
+    end
+  end
+end
+
+require_relative "canlii/rails/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: canlii
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ajay Krishnan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: A lightweight Ruby client for accessing Canadian legal information via
+  the CanLII API
+email:
+- 50063680+ajaynomics@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/canlii.rb
+- lib/canlii/base.rb
+- lib/canlii/case.rb
+- lib/canlii/client.rb
+- lib/canlii/configuration.rb
+- lib/canlii/database.rb
+- lib/canlii/errors.rb
+- lib/canlii/rails/railtie.rb
+- lib/canlii/version.rb
+homepage: https://github.com/ajaynomics/canlii-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ajaynomics/canlii-ruby
+  source_code_uri: https://github.com/ajaynomics/canlii-ruby
+  changelog_uri: https://github.com/ajaynomics/canlii-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Ruby client for the CanLII API
+test_files: []