documentcloud 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDM0YWJjYjM3NzQ2Y2U0OTEzMWQyNDk0MTY0Yjg4NDZmMGJhYjdjZQ==
+  data.tar.gz: !binary |-
+    NzQ1MTkxYTI4YzFiZTE3Y2RhOGVjMWYwYmExOWU3MjllODY2MzU3NA==
+SHA512:
+  metadata.gz: !binary |-
+    ZDY0Y2U3NzZlMzIzMzgzMmRmYjQ5ZDk5M2JlZDZhZjcyNzNhNjQzNzUxNGI2
+    ZDQyNGQ4NTcxN2VhZWIyOTYwYWE5M2Y3YmZkYmQ4Yzg3ZGEyYTU0ZDI2MWI2
+    ZWQwMjYyYTIzZDUzZjE1NDdmNjhhMDNkOWQxMjBhZWU3ODhiYWE=
+  data.tar.gz: !binary |-
+    ZjkzZjJhNGY0MDJlMDZhMzJjZTFmZDU5ZWM1N2MwZDY4M2EzNmJiMjhkNmUz
+    NDkwMzJhZDY0ZGIyZjQ5ZDFlMTZmMTEzMjg0NGVkM2UyNjg1NWFkYzk5ZTZm
+    NTgyYTMwYzRmY2JhMTc0NGQ1YWE0ZjExNTVlZDViOGI0MWM0Mzc=

data/README.md

@@ -1,7 +1,7 @@
 DocumentCloud RubyGem
 =====================
 
-Rubygem for interacting with the DocumentCloud API
+Rubygem for interacting with the DocumentCloud API.
 
 
 ## Usage
@@ -44,6 +44,35 @@ remote_doc = DocumentCloud.upload('http://somesite.com/file.pdf', 'Document Titl
 Both return a document object which can then be used.
 
 
-### Information
+### Document
+
+Fetch a document by passing the document id.
+
+``` ruby
+doc = DocumentCloud.document('1234-document-id')
+```
+
+
+
+### Update
+
+Update a document by providing the file id, and any parameters you want to change.
+
+``` ruby
+updated_doc = DocumentCloud.update('1234-file-name', title: 'Changed Document Title')
+```
+
+
+### Destroy
+
+Destroy a document simply by passing the document id.
+
+``` ruby
+DocumentCloud.destroy('1234-file-name')
+```
+
+
+
+## Information
 
 DocumentCloud API info: http://www.documentcloud.org/help/api

data/lib/document_cloud/api/destroy.rb

@@ -0,0 +1,22 @@
+module DocumentCloud
+  module API
+    module Destroy
+      include DocumentCloud::API::Utils
+      DOCUMENT_PATH = "/documents"
+      
+      # Delete a document
+      #
+      # @param id [String] The document id
+      def destroy(id)
+        delete(document_path(id))
+      end
+      
+      private
+            
+        def document_path(document_id)
+          "#{DOCUMENT_PATH}/#{document_id.to_s}.json"
+        end
+      
+    end
+  end
+end

data/lib/document_cloud/api/document.rb

@@ -2,7 +2,7 @@ module DocumentCloud
   module API
     module Document
       include DocumentCloud::API::Utils
-      DOCUMENT_PATH = "/documents/"
+      DOCUMENT_PATH = "/documents"
       
       # Fetch a document
       #

data/lib/document_cloud/api/update.rb

@@ -0,0 +1,32 @@
+module DocumentCloud
+  module API
+    module Update
+      include DocumentCloud::API::Utils
+      DOCUMENT_PATH = "/documents"
+      
+      # Update a document
+      #
+      # @see http://www.documentcloud.org/help/api
+      # @param id [String] The document id
+      # @param options [Hash] Customizable set of options
+      # @param options [String]  :title           The document's cannonical title
+      # @param options [String]  :source          The source who produced the document
+      # @param options [String]  :description     A paragraph of detailed description
+      # @param options [String]  :related_article The URL of the article associated with the document
+      # @param options [String]  :published_url   The URL of the page on which the document will be embedded
+      # @param options [String]  :access          One of 'public', 'private', 'organization', defaults to 'private'
+      # @param options [Hash]    :data            A hash of arbitrary key/value data pairs
+      # @returns [DocumentCloud::Document] The document uploaded
+      def update(id, options={})
+        build_object DocumentCloud::Document, put(document_path(id), options)
+      end
+      
+      private
+            
+        def document_path(document_id)
+          "#{DOCUMENT_PATH}/#{document_id.to_s}.json"
+        end
+      
+    end
+  end
+end

data/lib/document_cloud/client.rb

@@ -3,6 +3,8 @@ require_relative 'api/utils'
 require_relative 'api/search'
 require_relative 'api/upload'
 require_relative 'api/document'
+require_relative 'api/update'
+require_relative 'api/destroy'
 
 module DocumentCloud
   class Client
@@ -10,6 +12,8 @@ module DocumentCloud
     include DocumentCloud::API::Search
     include DocumentCloud::API::Upload
     include DocumentCloud::API::Document
+    include DocumentCloud::API::Update
+    include DocumentCloud::API::Destroy
     include DocumentCloud::Configurable
     
     def initialize(options={})
@@ -23,10 +27,21 @@ module DocumentCloud
       RestClient.get request_base+path, {params: params}
     end
     
+    # Perform HTTP POST request
     def post(path, params={})
       RestClient.post request_base+path, params
     end
     
+    # Perform HTTP PUT request
+    def put(path, params={})
+      RestClient.put request_base+path, params
+    end
+    
+    # Perform HTTP DELETE request
+    def delete(path)
+      RestClient.delete request_base+path
+    end
+    
     private
     
       def request_base

data/lib/document_cloud/version.rb

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

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: documentcloud
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Miles Zimmerman
@@ -14,7 +13,6 @@ 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,8 +48,10 @@ files:
 - LICENSE
 - README.md
 - documentcloud.gemspec
+- lib/document_cloud/api/destroy.rb
 - lib/document_cloud/api/document.rb
 - lib/document_cloud/api/search.rb
+- lib/document_cloud/api/update.rb
 - lib/document_cloud/api/upload.rb
 - lib/document_cloud/api/utils.rb
 - lib/document_cloud/client.rb
@@ -67,27 +64,25 @@ files:
 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.24
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rubygem for interacting with the DocumentCloud API
 test_files: []
-has_rdoc: