caselaw 0.1.0

data/lib/caselaw/client/cases.rb

@@ -0,0 +1,32 @@
+module Caselaw
+  module Cases
+    API_ENDPOINT = "cases/"
+
+    def case(id, full_case = false)
+      id_path = id.to_s
+      path = API_ENDPOINT + id_path
+      path = path + "?full_case=true" if full_case == true
+      Hashie::Mash.new(request(path))
+    end
+
+    def cases_by_jurisdiction(jurisdiction_term, num_cases, full_case = false)
+      slug = slug(jurisdiction_term)
+      path = API_ENDPOINT + "?jurisdiction=" + slug
+      path = path + "&full_case=true" if full_case == true
+      tempArray = paginated_request(path, num_cases)
+      Hashie::Mash.new(resultsCount: tempArray.count, results: tempArray)
+    end
+
+    # Search through text of cases and return cases that contain the word
+    def search_cases(term, num_cases, jurisdiction_term=nil)
+      if jurisdiction_term != nil
+        slug = slug(jurisdiction_term)
+        path = API_ENDPOINT + "?search=" + term + "&jurisdiction=" + slug
+      else
+        path = API_ENDPOINT + "?search=" + term
+      end
+      tempArray = paginated_request(path, num_cases)
+      Hashie::Mash.new(resultsCount: tempArray.count, results: tempArray)
+    end
+  end
+end

data/lib/caselaw/client/citations.rb

@@ -0,0 +1,4 @@
+module Caselaw
+  module Citations
+  end
+end

data/lib/caselaw/client/courts.rb

@@ -0,0 +1,4 @@
+module Caselaw
+  module Courts
+  end
+end

data/lib/caselaw/client/jurisdictions.rb

@@ -0,0 +1,17 @@
+module Caselaw
+  module Jurisdictions
+    API_ENDPOINT = "jurisdictions/"
+
+    # Return all Jurisdictions
+    def search_jurisdictions
+      Hashie::Mash.new(request(API_ENDPOINT))
+    end
+
+    # Search for a specific Jurisdiction
+    def jurisdiction(jurisdiction_term)
+      slug = slug(jurisdiction_term)
+      path = API_ENDPOINT + slug
+      Hashie::Mash.new(request(path))
+    end
+  end
+end

data/lib/caselaw/client/reporters.rb

@@ -0,0 +1,4 @@
+module Caselaw
+  module Reporters
+  end
+end

data/lib/caselaw/client/volumes.rb

@@ -0,0 +1,4 @@
+module Caselaw
+  module Volumes
+  end
+end

data/lib/caselaw/errors.rb

@@ -0,0 +1,7 @@
+module Caselaw
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class Forbidden < Error; end
+  class Unauthorized < Error; end
+  class NotFound < Error; end
+end

data/lib/caselaw/jurisdiction.rb

@@ -0,0 +1,90 @@
+module Caselaw
+  class Jurisdiction
+    attr_accessor :name, :id, :slug
+
+    def initialize(name, id, slug)
+      self.name = name
+      self.id = id
+      self.slug = slug
+    end
+
+    def self.all
+      [
+        Jurisdiction.new("Alabama", 23, "ala"),
+        Jurisdiction.new("Alaska", 53, "alaska"),
+        Jurisdiction.new("American Samoa", 58, "am-samoa"),
+        Jurisdiction.new("Arizona", 21, "ariz"),
+        Jurisdiction.new("Arkansas", 34, "ark"),
+        Jurisdiction.new("California", 30, "cal"),
+        Jurisdiction.new("Colorado", 31, "colo"),
+        Jurisdiction.new("Connecticut", 2, "conn"),
+        Jurisdiction.new("Dakota Territory", 55, "dakota-territory"),
+        Jurisdiction.new("District of Columbia", 56, "dc"),
+        Jurisdiction.new("Delaware", 8, "del"),
+        Jurisdiction.new("Florida", 28, "fla"),
+        Jurisdiction.new("Georgia", 3, "ga"),
+        Jurisdiction.new("Guam", 60, "guam"),
+        Jurisdiction.new("Hawaii", 40, "haw"),
+        Jurisdiction.new("Idaho", 27, "idaho"),
+        Jurisdiction.new("Illinois", 29, "ill"),
+        Jurisdiction.new("Indiana", 14, "ind"),
+        Jurisdiction.new("Iowa", 45, "iowa"),
+        Jurisdiction.new("Kansas", 43, "kan"),
+        Jurisdiction.new("Kentucky", 26, "ky"),
+        Jurisdiction.new("Louisiana", 10, "la"),
+        Jurisdiction.new("Massachusetts", 4, "mass"),
+        Jurisdiction.new("Maryland", 50, "md"),
+        Jurisdiction.new("Maine", 42, "me"),
+        Jurisdiction.new("Michigan", 49, "mich"),
+        Jurisdiction.new("Minnesota", 36, "minn"),
+        Jurisdiction.new("Mississippi", 16, "miss"),
+        Jurisdiction.new("Missouri", 37, "mo"),
+        Jurisdiction.new("Montana", 20, "mont"),
+        Jurisdiction.new("Native American", 61, "native-american"),
+        Jurisdiction.new("Navajo Nation", 41, "navajo-nation"),
+        Jurisdiction.new("North Carolina", 5, "nc"),
+        Jurisdiction.new("North Dakota", 18, "nd"),
+        Jurisdiction.new("Nebraska", 51, "neb"),
+        Jurisdiction.new("Nevada", 48, "nev"),
+        Jurisdiction.new("New Hampshire", 47, "nh"),
+        Jurisdiction.new("New Jersey", 24, "nj"),
+        Jurisdiction.new("New Mexico", 52, "nm"),
+        Jurisdiction.new("Northern Mariana Islands", 57, "n-mar-i"),
+        Jurisdiction.new("New York", 1, "ny"),
+        Jurisdiction.new("Ohio", 22, "ohio"),
+        Jurisdiction.new("Oklahoma", 13, "okla"),
+        Jurisdiction.new("Oregon", 19, "or"),
+        Jurisdiction.new("Pennsylvania", 6, "pa"),
+        Jurisdiction.new("Puerto Rico", 25, "pr"),
+        Jurisdiction.new("Regional", 9, "regional"),
+        Jurisdiction.new("Rhode Island", 15, "ri"),
+        Jurisdiction.new("South Carolina", 59, "sc"),
+        Jurisdiction.new("South Dakota", 54, "sd"),
+        Jurisdiction.new("Tennessee", 11, "tenn"),
+        Jurisdiction.new("Texas", 32, "tex"),
+        Jurisdiction.new("Tribal Jurisdictions", 62, "tribal"),
+        Jurisdiction.new("United States", 39, "us"),
+        Jurisdiction.new("Utah", 12, "utah"),
+        Jurisdiction.new("Virginia", 7, "va"),
+        Jurisdiction.new("Virgin Islands", 44, "vi"),
+        Jurisdiction.new("Vermont", 17, "vt"),
+        Jurisdiction.new("Washington", 38, "wash"),
+        Jurisdiction.new("Wisconsin", 46, "wis"),
+        Jurisdiction.new("West Virginia", 35, "w-va"),
+        Jurisdiction.new("Wyoming", 33, "wyo")
+      ]
+    end
+
+    def self.get_by_name(name)
+      jurisdiction = all.find { |j| j.name.downcase == name.downcase }
+      fail(Caselaw::NotFound, "Jurisdiciton not found, please check spelling.") if jurisdiction.nil?
+      jurisdiction.slug
+    end
+
+    def self.get_by_id(id)
+      jurisdiction = all.find { |j| j.id == id }
+      fail(Caselaw::NotFound, "Jurisdiciton not found, please check id referenced.") if jurisdiction.nil?
+      jurisdiction.slug
+    end
+  end
+end

data/lib/caselaw/request.rb

@@ -0,0 +1,61 @@
+require "httparty"
+require "hashie"
+
+module Caselaw
+  module Request
+    API_ROOT = "https://api.case.law/v1/"
+
+    def request(path)
+      token = api_key || Caselaw.configuration[:api_key]
+      fail(Caselaw::ConfigurationError, "API key is required.") if token.nil?
+
+      res = HTTParty.get(API_ROOT + path, headers: {"Authorization" => "Token " + token}) 
+        case res.code
+        when 200
+          parsed_response(res)
+        when 404
+          fail(Caselaw::NotFound)
+        end
+    end
+
+    def paginated_request(path, num)
+      token = api_key || Caselaw.configuration[:api_key]
+      fail(Caselaw::ConfigurationError, "API key is required.") if token.nil?
+
+      count = 0
+      pageCount = 1
+      nextPageExists = true
+      tempArray = []
+      path = API_ROOT + path
+      
+      initialRes = HTTParty.get(path, headers: {"Authorization" => "Token " + token})
+      initialRes = initialRes.parsed_response
+
+      while nextPageExists && count <= num
+        puts "-- | Page " + pageCount.to_s
+        res = HTTParty.get(path, headers: {"Authorization" => "Token " + token})
+        res = res.parsed_response
+        data = res['results']
+        
+        count += data.count
+        pageCount += 1
+        tempArray.push(*data)
+        res['next'] != nil ? path = res['next'] : nextPageExists = false
+      end
+      tempArray = tempArray[0, num] if tempArray.count > num
+      tempArray
+    end
+
+    def parsed_response(res)
+      res.parsed_response
+    end
+
+    def slug(jurisdiction_term)
+      if jurisdiction_term.is_a?(String)
+        Caselaw::Jurisdiction.get_by_name(jurisdiction_term)
+      elsif jurisdiction_term.is_a?(Integer)
+        Caselaw::Jurisdiction.get_by_id(jurisdiction_term)
+      end
+    end
+  end
+end

data/lib/caselaw/version.rb

@@ -0,0 +1,3 @@
+module Caselaw
+  VERSION = "0.1.0"
+end

data/spec/caselaw_spec.rb

@@ -0,0 +1,13 @@
+require 'caselaw'
+
+RSpec.describe Caselaw do
+  it "has a version number" do
+    expect(Caselaw::VERSION).not_to be nil
+  end
+
+  describe ".new" do
+    it "returns a new client instance" do
+      expect(Caselaw.new).to be_a(Caselaw::Client)
+    end
+  end 
+end

data/spec/client_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+RSpec.describe Caselaw::Client do
+  let(:client)  { Caselaw::Client.new(api_key: "SECRET_KEY") }
+  before(:each) { Caselaw.reset_configuration }
+  
+  describe "new" do
+    it "requires a hash argument" do
+      expect { Caselaw::Client.new("Tom") }
+        .to raise_error(ArgumentError, "API key hash is required.")
+    end
+  end
+
+  describe "slug" do
+    it "gets 62 jurisdictions" do
+      expect(Caselaw::Jurisdiction.all.length).to eq 62
+    end
+
+    it "finds a slug by name, case-insensitive" do
+      expect(Caselaw::Jurisdiction.get_by_name("Colorado")).to eq "colo"
+      expect(Caselaw::Jurisdiction.get_by_name("colorado")).to eq "colo"
+    end
+
+    it "finds a slug by id" do
+      expect(Caselaw::Jurisdiction.get_by_id(31)).to eq "colo"
+    end
+      
+    context "when jurisdiction does not exist" do
+      it "raises Caselaw::NotFound" do
+        expect { Caselaw::Jurisdiction.get_by_name("Tom") }.to raise_error(Caselaw::NotFound)
+        expect { Caselaw::Jurisdiction.get_by_id(2000) }.to raise_error(Caselaw::NotFound)
+      end
+    end
+  end
+
+  describe "get jurisdictions" do
+    before { stub("jurisdictions/", "jurisdictions.json") }
+    
+    it "returns all jurisdictions" do
+      search = client.search_jurisdictions
+      results = client.search_jurisdictions['results']
+      expect(search).to be_a Hashie::Mash
+      expect(results).to be_an(Array)
+    end
+  end
+
+  describe "case" do
+    before { stub("cases/1021505", "case.json") }
+
+    it "returns case instance" do
+      case_instance = client.case(1021505)
+      expect(case_instance).to be_a Hashie::Mash
+      expect(case_instance.id).to eq 1021505
+    end
+
+    context "when case does not exist" do
+      before {stub_request(:get, "https://api.case.law/v1/cases/1021505000")
+         .with(
+           headers: {
+       	  'Authorization'=>'Token SECRET_KEY'
+           })
+         .to_return(status: 200, body: "", headers: {})}
+      
+      it "raises Caselaw::NotFound" do
+        expect(client.case(1021505000).to raise_error(Caselaw::NotFound))
+      end
+    end
+  end    
+end

data/spec/fixtures/case.json

@@ -0,0 +1,39 @@
+{
+  "id": 1021505,
+  "url": "https://api.case.law/v1/cases/1021505/",
+  "name": "William Stone against William Boreman",
+  "name_abbreviation": "Stone v. Boreman",
+  "decision_date": "1658",
+  "docket_number": "",
+  "first_page": "1",
+  "last_page": "5",
+  "citations": [
+    {
+      "type": "official",
+      "cite": "1 Md. 1"
+    }
+  ],
+  "volume": {
+    "url": "https://api.case.law/v1/volumes/32044057896128/",
+    "volume_number": "1"
+  },
+  "reporter": {
+    "url": "https://api.case.law/v1/reporters/732/",
+    "full_name": "Maryland reports, being a series of the most important law cases argued and determined in the Provincial Court and Court of Appeals of the then province of Maryland, from the year 1700 [i.e. 1658] down to the [end of 1799]"
+  },
+  "court": {
+    "url": "https://api.case.law/v1/courts/md/",
+    "id": 8823,
+    "slug": "md",
+    "name": "Court of Appeals of Maryland",
+    "name_abbreviation": "Md."
+  },
+  "jurisdiction": {
+    "url": "https://api.case.law/v1/jurisdictions/md/",
+    "id": 50,
+    "slug": "md",
+    "name": "Md.",
+    "name_long": "Maryland",
+    "whitelisted": false
+  }
+}

data/spec/fixtures/full_case.json

@@ -0,0 +1,63 @@
+{
+  "id": 1021505,
+  "url": "https://api.case.law/v1/cases/1021505/",
+  "name": "William Stone against William Boreman",
+  "name_abbreviation": "Stone v. Boreman",
+  "decision_date": "1658",
+  "docket_number": "",
+  "first_page": "1",
+  "last_page": "5",
+  "citations": [
+    {
+      "type": "official",
+      "cite": "1 Md. 1"
+    }
+  ],
+  "volume": {
+    "url": "https://api.case.law/v1/volumes/32044057896128/",
+    "volume_number": "1"
+  },
+  "reporter": {
+    "url": "https://api.case.law/v1/reporters/732/",
+    "full_name": "Maryland reports, being a series of the most important law cases argued and determined in the Provincial Court and Court of Appeals of the then province of Maryland, from the year 1700 [i.e. 1658] down to the [end of 1799]"
+  },
+  "court": {
+    "url": "https://api.case.law/v1/courts/md/",
+    "id": 8823,
+    "slug": "md",
+    "name": "Court of Appeals of Maryland",
+    "name_abbreviation": "Md."
+  },
+  "jurisdiction": {
+    "url": "https://api.case.law/v1/jurisdictions/md/",
+    "id": 50,
+    "slug": "md",
+    "name": "Md.",
+    "name_long": "Maryland",
+    "whitelisted": false
+  },
+  "casebody": {
+    "status": "ok",
+    "data": {
+      "head_matter": "PROVINCIAL COURT,\nWilliam Stone against William Boreman.\n1658.\non Tuesday, August 2, 1659.\nPresent — His Excellency, Josias Fendall, Esq. Governor and Chief Justice.\n(\"Philip Calvert, Esq. Secretary,!\nThe Hon. -I Col. Nathaniel Utye, Esq. > Councillors.\n[Mr. Edward Lloyd, Esq. J\nUPON the difference between Capt. William Stone and William Boreman, touching the said Boreman!s land at Nanjemoy, it appearing to this Court that the said Bore-man did not legally pursue his warrant for four hundred acres of land within the time of the said warrant prescribed — It is ordered by this Court that a patent immediately be passed to Capt. William Stone of the land by him demanded, and in regard that the said Boremarfs right to so much land doth yet remain unto him ; and the surveyor did, in his own wrong, survey and receive pay for survey of that land at Nanjemoy. It is ordered also by the Court that the said Boreman shall have 400 acres in some other convenient place, and the surveyor to lay it out without satisfaction or pay from the said Boreman.\nPROVINCIAL COURT, FEBRUARY, 1660.\n“ WHEREAS Edward Lloyd, maketh it appear to this “ Court per draughts and the plots of land surveyed for him “ in Wye River, that his long lines running S. E. he also “ having purchased two patents, next adjoining upon him ; “ thelong lines of which patents, running E. per which occa- “ sion he wants much of his due proportion of land. Upon u his motion and the consideration thereof, the Court hath “ thought fit and ordered that the long lines of the land “ purchased of William Granger shall run S. E. provided “ it prejudice no survey made before these presents.”\nLiber S.\nAt a Court holden in Anne Arundel County,",
+      "parties": [
+        "William Stone against William Boreman."
+      ],
+      "judges": [
+        "Present — His Excellency, Josias Fendall, Esq. Governor and Chief Justice."
+      ],
+      "attorneys": [
+        "(\"Philip Calvert, Esq. Secretary,!",
+        "The Hon. -I Col. Nathaniel Utye, Esq. > Councillors.",
+        "[Mr. Edward Lloyd, Esq. J"
+      ],
+      "opinions": [
+        {
+          "text": "WAS called before the Board George Dorr el, James Homewood, and other the inhabitants of the County of Anne Arundel, (being warned to appear upon special writ) who have not subscribed the engagement nor made oath of fidelity to his Lordship, according to the act of Assembly in that case provided, to shew cause why the several lands or plantations seated and planted by them should not be seized into the Lord Proprietary’s hands, they having not performed the conditions of plantations propounded and granted by his Lordship, whereby they may be made capable and assured of enjoying the same.\nIn answer thereto, George Dorr ell saith that he hath not subscribed the engagement, neither will he make oath of fidelity to his Lordship ; and further, that part of the land he now enjoyeth was taken up by him upon his own right for his transport, and part he purchased, and bought of Richard Youngs deceased, before the engagement was propounded, or tendered according to the act.\nJames Hometvood and Thomas Homewood say the same touching the engagement and oath of fidelity. Yet they presume to have right to the land they enjoy, for that they made oath of fidelity in Capt. Stone’s time of government, and seated their lands upon his Lordship’s promise.\nCol. Nathaniel Utye being desired by the Governor, to deliver his opinion in this point, saith, that those people who deny to comply with and fulfil such conditions of plantation propounded by his Lordship ought not to enjoy their lands although seated by them.\nMr. Edward Lloyd saith, that the articles not being performed, the land to belong to the Proprietary ; yet in his judgment there ought to be some consideration for the pains of clearing and charges of building upon the same.\nMr. Secretary. That no one can claim any land in this province but conditionally : that those conditions are not performed by those who have not subscribed the engagement, and therefore, that the lands of the non-subscribers be seized into the hands of the Lord Proprietary.\nGovernor. Whereas the Lord Proprietary did grant land to those who transported themselves into the Province provided that they fulfilled such conditions as his Lordship had thereunto annexed, which those people who did not take the oath of fidelity, or in room thereof, who did not subscribe the engagement, and do still refuse so to do, have no right or title to the land by them taken up ; and that the lands be therefore seized into the hands of the Lord Proprietary.\nIt is therefore ordered that the land of the said George Dorrell, and the lands also of all the other several inhabitants of the County of Anne Arundel, refusing to take the oath of fidelity to his Lordship, or subscribe the engagement according to the conditions of plantation by his said Lordship propounded, and instructions thereunto annexed, be forthwith seized into the hands of the Lord Proprietary.\nVide Lib. S. one of the Court of Appeals Records.\nProclamation, by the Lieutenant and Governor of Maryland.\nWhereas upon the surrender of the government to me by his Lordship’s Lieutenant on the 24th of March last past, amongst other things, it was then agreed that the oath of fidelity should not be pressed upon the inhabitants then residing within this province. But that in place and stead thereof an engagement should be taken in manner and form, as in those articles, relation unto them being had, more at large appeareth. And whereas by an act of this last General Assembly the said articles are confirmed, and the said engagement by law commanded to be taken. To the end the said articles may be inviolably observed, and that all jealousies and fears be removed — -These are in the Lord Proprietary’s name, strictly to charge, and command all persons whatsoever to make their repair to their clerks of their respective County Courts, at or before the 20th day of August, next ensuing, to make their subscriptions to the said engagement, or else that they provide themselves to depart the Province by the 25th day of March next; And to declare that all person's who shall be found in any part of this Province after the 25th of March afore said, shall be proceeded against as rebels and traitors.\nGiven under my hand this 23d of July, 1658.\nJosias Fendall.\nSee Liber S. fol. 71. the oldest record book of the prti ceedings in the Court of Appeals.\nWRIT.\nThese are to will and require you in the Lord Proprietary’s name, to summon all persons who have not subscribed the engagement within your County to appear at the meeting-house in the said County upon Tuesday, the 2d day of August next, then and there to shew cause why the lands in their possession, or pretended to be held by title derived from them, shall not be seized into the hands of the Lord Proprietary. Hereof fail not as you will answer the contrary at your peril.\nGiven under my hand this 23d day of July, 1659.\nJosias Fendall.\nTo the Sheriifof, &c.\nSee Liber S. fol. 279. Record of the Court of Appeals.",
+          "type": "majority",
+          "author": null
+        }
+      ]
+    }
+  }
+}

data/spec/fixtures/jurisdiction_colo.json

@@ -0,0 +1,8 @@
+{
+    "url": "https://api.case.law/v1/jurisdictions/colo/",
+    "id": 31,
+    "slug": "colo",
+    "name": "Colo.",
+    "name_long": "Colorado",
+    "whitelisted": false
+}