caselaw 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 493e52b698a4af0e3c322d186ed6e28b19ac7cf2
+  data.tar.gz: 580e3394c374550c997bac54a55cf41ef4202547
+SHA512:
+  metadata.gz: bbeaef183db925d6961e3c097166540c253a302c64fcc22a341c2b0fc1aa9440bcc495818561502c83c104543babec02f4feb4406a966f416107980ee4bb3691
+  data.tar.gz: b06d5e855658bd5c36df0fb28575520664bf5357edbfbf17e3dc804b4e289269fb387a87aedda8686207367e49fa0395a4e04d38bd18e8f9e87d3ef8b4cda413

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# test files
+sample-requests.txt
+/examples/test.rb

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.2.2
+before_install: gem install bundler -v 1.17.1

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 caselaw.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tom Bonan
+
+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,112 @@
+# CaseLaw API Wrapper
+
+## Installation
+
+Install with RubyGems
+
+```
+gem install caselaw
+```
+
+## Getting started
+
+In order to view non-whitelisted court cases, you must [register an account](https://case.law/user/register/) with Case.law and recieve an API key.
+
+### Setting up the Client
+
+``` ruby
+client = Caselaw::Client.new(api_key: "KEY")
+```
+
+or via the shorthand version
+
+``` ruby
+client = Caselaw.new(api_key: "KEY")
+```
+
+### Global configuration
+
+You can define the credentials for a client at a global level by creating an initiailize file. If using gem in Rails, add a file under `config/initializers`.
+
+``` ruby
+Caselaw.configure(
+  api_key: "KEY"
+)
+```
+
+To access the global configuration:
+
+``` ruby
+Caselaw.configuration
+```
+
+## Examples
+
+### Lookup a Jurisdiction
+
+You can lookup a Jurisdiction by id or the full name if unknown
+
+```ruby
+client.jurisdiction(31)
+client.jurisdiction("Colorado")
+```
+
+Or get all the Jurisdictions and related information
+
+```ruby
+search = client.search_jurisdictions
+
+search.results.each do |jurisdiction|
+  jurisdiction.id	     # => jurisdiction id
+  jurisdiction.name_long     # => jurisdiction full name
+  jurisdiction.slug          # => slug in use on the API
+end
+```
+
+### Lookup a case instance
+
+You can search for a case with a given case id
+
+```ruby
+client.case(1021505)
+```
+
+And to return the full body of the case instance, add the `true` parameter as the second argument
+
+```ruby
+client.case(1021505, true)
+```
+
+### Search for Cases by Text
+
+Search the full text of cases and return the cases that contain the search term. The second argument is the number of cases to be returned.
+
+```ruby
+client.search_cases("insurance", 20)
+```
+
+Or you can search multiple terms by separating the terms with a space
+```ruby
+client.search_cases("insurance Peoria", 20)
+```
+
+## Response Structure
+
+Each response comes in the form of a [Hashie](https://github.com/intridea/hashie) hash to make it easier to access the data. For instance, if we search case `1021505`, we can access information about it easily with Hashie:
+
+```ruby
+c = client.case(1021505)
+
+c.id			        # => 1021505
+c.url				# => "https://api.case.law/v1/cases/1021505/"
+c.name				# => "William Stone against William Boreman"
+c.name_abbreviation          # => "Stone v. Boreman"
+c.decision_date 		# => "1658"
+```
+
+As well as information about the Volume, Reporter, Court, and Jurisdiction that the case:
+
+```ruby
+c.court.name			# => "Maryland Court of Appeals"
+c.jurisdiction.name_long 	# => "Maryland"
+```

data/Rakefile

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

data/caselaw.gemspec

@@ -0,0 +1,31 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "caselaw/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "caselaw"
+  spec.version       = Caselaw::VERSION
+  spec.authors       = ["tombonan"]
+  spec.email         = ["tombonan27@gmail.com"]
+  spec.summary       = "Case.law API wrapper"
+  spec.description   = "Wrapper for the Caselaw Access Project API"
+  spec.homepage      = "https://github.com/tombonan/caselaw"
+  spec.license       = "MIT"
+
+  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 "webmock", "~> 3.5"
+  
+  spec.add_runtime_dependency "httparty", "~> 0.16.3"
+  spec.add_runtime_dependency "hashie", "~> 3.6"
+
+  spec.post_install_message = "Welcome to the Case Law party!"
+
+  all_files = `git ls-files`.split("\n")
+  test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  spec.files         = all_files - test_files
+  spec.test_files    = test_files
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/docs/README.md

@@ -0,0 +1,92 @@
+## Table of Contents
+
+- [Jurisdictions](#jurisdictions)
+- [Cases](#cases)
+
+## Jurisdictions
+
+### Specific Jurisdiction Information
+
+You can lookup a jurisdiction by id
+
+```ruby
+client.jurisdiction(31)
+```
+
+or by the full name if the id is unknown
+
+```ruby
+client.jurisdiction("Colorado")
+```
+
+### Returning All Jurisdiction Information
+
+To recieve an array with all 62 jurisdictions and related information
+
+```ruby
+search = client.search_jurisdictions
+jurisdiction_array = search.results
+```
+
+### Jurisdiction Slugs
+
+The Caselaw API uses jurisdiction slugs to filter requests. If you wish to find out the slug of a specific jurisdiction
+
+```ruby
+slug = Caselaw::Jurisdiction.get_by_name("Utah") # => 'utah'
+```
+
+or you can retrieve the slug by the jurisdiction id
+
+```ruby
+slug = Caselaw::Jurisdiction.get_by_id(12) # => 'utah'
+```
+
+## Cases
+
+### Specific Case Instances
+
+You can lookup a specific case by its id
+
+```ruby
+client.case(1021505)
+```
+
+And to return the full body of the case, add the `true` parameter as the second argument
+
+```ruby
+client.case(1021505, true)
+```
+
+### Cases by Jurisdiction
+
+To return an array of cases by jurisdiction, search either by jurisdiction id or name and enter in the number of cases you want returned as the second argument
+
+```ruby
+client.cases_by_jurisdiciton("Colorado", 20)
+client.cases_by_jurisdiciton(31, 20)
+```
+
+This method can also return the full body of a case
+
+```ruby
+client.cases_by_jurisdiciton("Colorado", 20, true)
+client.cases_by_jurisdiciton(31, 20, true)
+```
+
+### Cases by Search Term
+
+Search through cases that have a specific search term in the body of the case. The first argument is the search term and the second is the maximum number of case results you wish to return
+
+```ruby
+client.search_cases("witchcraft", 30)
+```
+
+You can also search through the text of cases by jurisdiction where the third argument is the jurisdiciton id or name
+
+```ruby
+client.search_cases("witchcraft", 30, 31)
+client.search_cases("witchcraft", 30, "Colorado")
+```
+
+

data/examples/README.md

@@ -0,0 +1,14 @@
+## Usage
+In order to run scripts:
+
+Clone this repositiory and replace `"KEY"` with your provided API key as a string, or
+
+Copy the script and replace the first two lines with `require 'caselaw'` after installing the gem, and then replace the API key as before
+
+## Examples
+
+* [Get all Jurisdictions](jurisdictions.rb)
+  * Print out a list of jurisdictions and related info
+
+* [Searching Cases by Text](witchcraft.rb)
+  * Print out a search of the first 40 cases that contain the word "witchcraft" in the text of the case

data/examples/jurisdictions.rb

@@ -0,0 +1,13 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'caselaw')
+require 'pp'
+
+client = Caselaw::Client.new(api_key: "KEY")
+
+search = client.search_jurisdictions
+
+search.results.each do |jurisdiction|
+  pp "Name: " + jurisdiction.name_long + " | ID: " + jurisdiction.id.to_s + " | Slug: " + jurisdiction.slug
+end
+
+

data/examples/witchcraft.rb

@@ -0,0 +1,12 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'caselaw')
+require 'pp'
+
+client = Caselaw::Client.new(api_key: "KEY")
+
+cases = client.search_cases("witchcraft", 40)
+
+cases.results.each do |c|
+  pp "Jurisdiction: " + c.jurisdiction.name_long + " || " + "Case Name: " + c.name
+end
+  

data/lib/caselaw.rb

@@ -0,0 +1,35 @@
+require "caselaw/version"
+require "caselaw/errors"
+require "caselaw/request"
+require "caselaw/client"
+require "caselaw/jurisdiction"
+
+module Caselaw
+  class << self
+    attr_accessor :settings
+  end
+  self.settings = {}
+
+  def self.new(params = {})
+    Caselaw::Client.new(params)
+  end
+
+  # Global configuration settings
+  def self.configure(params = {})
+    fail(ArgumentError, "API key hash required.") unless params.is_a?(Hash)
+    
+    settings[:api_key] = params[:api_key]
+    settings
+  end
+
+  # Return global config hash
+  def self.configuration
+    settings
+  end
+
+  # Resets the global configuration
+  def self.reset_configuration
+    self.settings = {}
+  end
+
+end

data/lib/caselaw/client.rb

@@ -0,0 +1,26 @@
+require "caselaw/client"
+require "caselaw/client/cases"
+require "caselaw/client/citations"
+require "caselaw/client/courts"
+require "caselaw/client/jurisdictions"
+require "caselaw/client/reporters"
+require "caselaw/client/volumes"
+
+module Caselaw
+  class Client
+    include Caselaw::Request
+    include Caselaw::Cases
+    include Caselaw::Citations
+    include Caselaw::Courts
+    include Caselaw::Jurisdictions
+    include Caselaw::Reporters
+    include Caselaw::Volumes
+    
+    attr_reader :api_key
+
+    def initialize(settings = {})
+      fail(ArgumentError, "API key hash is required.") unless settings.is_a?(Hash)
+      @api_key = settings[:api_key]
+    end
+  end
+end