documentcloud 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a2ba9016818c201c571162ff42d1938061fb0c5
-  data.tar.gz: 34da50fa8a060bf8362ab4caf368619c044b1d9c
+SHA256:
+  metadata.gz: f9246d4e52daa3300321aab26de5f74ceaa1bd3e8db55e36f646bfaf0b4d145b
+  data.tar.gz: 52db5f9feb9c8ecbda730d8ed81d10d88c5192cc273df9cce8f4bcf0bcb7a697
 SHA512:
-  metadata.gz: 3ffa8a59036e54a0959825e82a91e5450cb63962f66db7178054e5b4f554a61c7b73dd5c549e21a899d6115ac3b2d364a7070968d4a18bf1761b0439013044e8
-  data.tar.gz: 0506b8d8b85e603597158475a36f6cf6f1f784fe91a3d718fc30e576ef04430c96efb2a02579e228afbee899f6b628b2d1b588c8d03a44a7551f20d707c137e0
+  metadata.gz: 284d55daeac7b16db5da94f413302651414488295aaf41b7cf00e74999604a57ae824cade9f80a6884d1b42ec811d6d94ab0f09a9d1f775107305d2e8ad65074
+  data.tar.gz: c17739b957b99d71e2e038e644595b75e12a15821a70e56ba94d550ac417e90aa90a54d67ac783c98cf27757324e1297b738544adbafcea2bd1bb336359589f8

data/README.md

@@ -1,34 +1,55 @@
-DocumentCloud RubyGem
-=====================
-
+# DocumentCloud RubyGem #
 [![Gem Version](https://badge.fury.io/rb/documentcloud.png)](http://badge.fury.io/rb/documentcloud)
+[![Build Status](https://travis-ci.org/mileszim/documentcloud.svg?branch=master)](https://travis-ci.org/mileszim/documentcloud)
 
 Rubygem for interacting with the DocumentCloud API
 
 
+## Install ##
+Add to your Gemfile
+``` ruby
+gem 'documentcloud', '~> 0.5.0'
+```
 
-## Usage
+## Authentication ##
 
-```gem install documentcloud``` or put in your gemfile and ```bundle install```
+#### Ruby applications or Rails < 5.1 ####
+Use a gem like dotenv or manually add them:
 
-then
+``` bash
+$ DOCUMENTCLOUD_EMAIL='myemail@emailprovider.tld' \
+DOCUMENTCLOUD_PASSWORD='my super secure password' \
+ruby main.rb
+```
+
+You can then initialize using `ENV['DOCUMENTCLOUD_EMAIL']` (and pass) in either client or for rails, an initializer:
+
+Add file `config/intializers/documentcloud.rb`:
 ``` ruby
-require 'documentcloud'
+DocumentCloud.configure do |config|
+  config.email = ENV['DOCUMENTCLOUD_EMAIL']
+  config.password = ENV['DOCUMENTCLOUD_PASSWORD']
+end
 ```
-if not in Rails
 
-To authenticate, initialize the configuration and pass in a block:
 
+#### Rails >= 5.1 ####
+Add file `config/intializers/documentcloud.rb`:
 ``` ruby
 DocumentCloud.configure do |config|
-  config.email    = 'my_email@somedomain.com'
-  config.password = 'my_secret_password'
+  config.email = Rails.application.credentials.documentcloud[:email]
+  config.password = Rails.application.credentials.documentcloud[:password]
 end
 ```
 
+##### Rails 5.1 #####
+[Add your documentcloud credentials using Rails 5.1 encrypted secrets](https://www.engineyard.com/blog/encrypted-rails-secrets-on-rails-5.1)
+
+##### Rails 5.2 #####
+[Add your documentcloud credentials using Rails 5.2 encrypted secrets](https://medium.com/cedarcode/rails-5-2-credentials-9b3324851336)
 
-### Search
 
+### Search ###
 All search results return Document objects that has methods and accessors for the information.
 
 ``` ruby
@@ -40,8 +61,7 @@ puts search.documents[0].pdf
 ```
 
 
-### Upload
-
+### Upload ###
 You can upload a document by providing a ruby File object, or a string with the url to a file.
 
 ``` ruby
@@ -53,12 +73,10 @@ remote_doc = DocumentCloud.upload('http://somesite.com/file.pdf', 'Document Titl
 Both return a document object which can then be used.
 
 
-## Objects
-
+## Objects ##
 This gem creates several objects built from the JSON response in order to provide convenience methods and accessors.
 
-### Document
-
+### Document ###
 Document objects wrap any document JSON. They are returned in search results, upload, and document methods.
 
 ``` ruby
@@ -87,7 +105,7 @@ doc.entities          # Returns a hash of entities and their relevance
 doc.image(page, size) # Returns the image of a page at the specified size
 ```
 
-### Search Results
+### Search Results ###
 SearchResults objects return information about the search, and an array of Document objects
 
 ``` ruby
@@ -103,11 +121,11 @@ results.documents # Array of documents of results:
 results.documents[0].title # First result title
 ```
 
-### Projects
+### Projects ###
 Projects returns an array of Project objects which contain a list of Documents and
 metadata about the project.
 
-```ruby
+``` ruby
 projects = DocumentCloud.projects
 
 project = projects.first
@@ -119,35 +137,41 @@ project.description
 project.documents # Returns an array of Document objects
 ```
 
-### Entities
+### Entities ###
 Entities takes a document id and returns a hash of entities, which
 include a value and relevance for each type of entity.
 
-```ruby
+``` 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}]
- }
+  :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
+## Information ##
 
 DocumentCloud API info: http://www.documentcloud.org/help/api

data/documentcloud.gemspec

@@ -1,23 +1,27 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'document_cloud/version'
+require "document_cloud/version"
 
 Gem::Specification.new do |spec|
-  spec.add_dependency "rest-client", "~> 1.8"
-  spec.add_dependency 'multi_json', '~> 1.8'
-
-  spec.name          = 'documentcloud'
+  spec.name          = "documentcloud"
   spec.version       = DocumentCloud::Version
   spec.description   = "Rubygem for interacting with the DocumentCloud API"
   spec.summary       = spec.description
   spec.authors       = ["Miles Zimmerman"]
-  spec.email         = ['mileszim@protonmail.com']
-  spec.homepage      = 'https://github.com/mileszim/documentcloud'
-  spec.licenses      = ['MIT']
+  spec.email         = ["mileszim@protonmail.com"]
+  spec.homepage      = "https://github.com/mileszim/documentcloud"
+  spec.licenses      = ["MIT"]
 
   spec.files         = %w(LICENSE README.md documentcloud.gemspec)
   spec.files        += Dir.glob("lib/**/*.rb")
 
-  spec.require_paths = ['lib']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 1.8"
+  spec.add_dependency "multi_json", "~> 1.8"
+
+  spec.add_development_dependency "rspec", "~> 3.8"
 end

data/lib/document_cloud/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentcloud
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Miles Zimmerman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-03 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 description: Rubygem for interacting with the DocumentCloud API
 email:
 - mileszim@protonmail.com
@@ -87,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rubygem for interacting with the DocumentCloud API