documentcloud 0.3.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85624f45e49e63cca8533313979668d61170ff70
+  data.tar.gz: 8262d41db09bac2fed94a9f9e3fc1452ffa99323
+SHA512:
+  metadata.gz: 367417f221e27d26c82dae344bed4a1a791df1dc113bea75a4a1b76f424ca4e998a378a5b63dc1309b1c1fbc555d4f4bf8766f0fd2c611d889d2848aa89495ed
+  data.tar.gz: df90ed5492641788f203b12406173c9cfcf350815598aae63d25a8057087495063344285f3c3633c204fb1a6202a51217d52ec1798c0db1b201a4a11c5e170ad

data/README.md

@@ -81,6 +81,7 @@ doc.print_annotations
 doc.related_article
 doc.text              # Raw parsed text from document
 doc.thumbnail         # Primary thumbnail of document
+doc.entities          # Returns a hash of entities and their relevance
 
 # Images
 doc.image(page, size) # Returns the image of a page at the specified size
@@ -102,8 +103,51 @@ results.documents # Array of documents of results:
 results.documents[0].title # First result title
 ```
 
+### Projects
+Projects returns an array of Project objects which contain a list of Documents and
+metadata about the project.
+
+```ruby
+projects = DocumentCloud.projects
+
+project = projects.first
+
+# Accessors
+project.id
+project.title
+project.description
+project.documents # Returns an array of Document objects
+```
+
+### Entities
+Entities takes a document id and returns a hash of entities, which
+include a value and relevance for each type of entity.
+
+```ruby
+entities = DocumentCloud.entities(2072158)
+
+# example output
+{
+  :person=>[{:value=>"Pita Sharples", :relevance=>0.112}],
+  :organization=>[{:value=>"Māori Party", :relevance=>0.48}],
+  :place=>[],
+  :term=>
+  [{:value=>"finance costs", :relevance=>0.552},
+   {:value=>"public services", :relevance=>0.526}],
+  :email=>[],
+  :phone=>[],
+  :city=>[],
+  :state=>[],
+  :country=>
+  [{:value=>"New Zealand", :relevance=>0.628},
+   {:value=>"Australia", :relevance=>0.302},
+   {:value=>"United States", :relevance=>0.295},
+   {:value=>"United Kingdom", :relevance=>0.295},
+   {:value=>"China", :relevance=>0.294}]
+ }
+```
 
 
 ## Information
 
-DocumentCloud API info: http://www.documentcloud.org/help/api
+DocumentCloud API info: http://www.documentcloud.org/help/api

data/lib/document_cloud/api/destroy.rb

@@ -14,9 +14,9 @@ module DocumentCloud
       private
             
         def document_path(document_id)
-          "#{DOCUMENT_PATH}/#{document_id.to_s}.json"
+          "#{DOCUMENT_PATH}/#{document_id.to_i}.json"
         end
       
     end
   end
-end
+end

data/lib/document_cloud/api/document.rb

@@ -15,9 +15,9 @@ module DocumentCloud
       private
             
         def document_path(document_id)
-          "#{DOCUMENT_PATH}/#{document_id.to_s}.json"
+          "#{DOCUMENT_PATH}/#{document_id.to_i}.json"
         end
       
     end
   end
-end
+end

data/lib/document_cloud/api/entities.rb

@@ -16,9 +16,9 @@ module DocumentCloud
       private
             
         def entities_path(document_id)
-          "#{DOCUMENT_PATH}/#{document_id.to_s}/#{ENTITIES_PATH}"
+          "#{DOCUMENT_PATH}/#{document_id.to_i}/#{ENTITIES_PATH}"
         end
       
     end
   end
-end
+end

data/lib/document_cloud/api/projects.rb

@@ -6,10 +6,10 @@ module DocumentCloud
 
       # List projects
       #
-      # @returns [Hash] The fetched document entities
+      # @returns [DocumentCloud::Project] An array of fetched project entities
       def projects
         build_objects DocumentCloud::Project, get(PROJECTS_PATH)
       end
     end
   end
-end
+end

data/lib/document_cloud/api/update.rb

@@ -24,9 +24,9 @@ module DocumentCloud
       private
             
         def document_path(document_id)
-          "#{DOCUMENT_PATH}/#{document_id.to_s}.json"
+          "#{DOCUMENT_PATH}/#{document_id.to_i}.json"
         end
       
     end
   end
-end
+end

data/lib/document_cloud/api/update_project.rb

@@ -20,9 +20,9 @@ module DocumentCloud
       private
             
         def project_path(project_id)
-          "#{PROJECT_PATH}/#{project_id.to_s}.json"
+          "#{PROJECT_PATH}/#{project_id.to_i}.json"
         end
       
     end
   end
-end
+end

data/lib/document_cloud/version.rb

@@ -2,7 +2,7 @@ module DocumentCloud
   class Version
     MAJOR = 0 unless defined? DocumentCloud::Version::MAJOR
     MINOR = 3 unless defined? DocumentCloud::Version::MINOR
-    PATCH = 1 unless defined? DocumentCloud::Version::PATCH
+    PATCH = 2 unless defined? DocumentCloud::Version::PATCH
     PRE = nil unless defined? DocumentCloud::Version::PRE
 
     class << self

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: documentcloud
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - Miles Zimmerman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -53,6 +48,7 @@ files:
 - LICENSE
 - README.md
 - documentcloud.gemspec
+- lib/document_cloud.rb
 - lib/document_cloud/api/create_project.rb
 - lib/document_cloud/api/destroy.rb
 - lib/document_cloud/api/document.rb
@@ -70,32 +66,29 @@ files:
 - lib/document_cloud/project.rb
 - lib/document_cloud/search_results.rb
 - lib/document_cloud/version.rb
-- lib/document_cloud.rb
 - lib/documentcloud.rb
 homepage: https://github.com/mileszim/documentcloud
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rubygem for interacting with the DocumentCloud API
 test_files: []
-has_rdoc: