doccy-api 0.0.1 → 0.0.2

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
 
 Create a doccy_api.rb file in your config/initializers folder and add the following
 
-	Doccy::Config.mode = :production" # OPTIONAL defaults to staging.
+	Doccy::Config.mode = :production # OPTIONAL defaults to staging.
 	Doccy::Config.app_key = "YOUR-PARTNER-KEY" #OPTIONAL you only need this to create client accounts.
 
 
@@ -55,7 +55,15 @@ Returns a specific Template
 
 
 Uploads a Teamplate to Doccy
-    
+
+- Method: `post`
+- Request Params:
+  - template[name]: Name of template in Doccy * Required
+  - template[description]: Optional
+  - template[document_template]: Template file to upload * Required
+  
+- Request Example: no request content
+ 
     Doccy::Templates.upload(auth_token, template_params)
 
 
@@ -63,7 +71,13 @@ Uploads a Teamplate to Doccy
 
 Creates a Document from Template
 
-    Doccy::Documents.create(auth_token, template_id, document_params)
+- Method: `post`
+- Request Params:
+  - document[name]: Name of document * Required
+  - document[content][:placeholder]: Placeholde should be replaced by the values returned from template show action
+
+  Doccy::Documents.create(auth_token, template_id, document_params)
+  
     
 Returns a specific Document
   
@@ -72,8 +86,9 @@ Returns a specific Document
 
 Downloads a Document
     
-    Doccy::Documents.download(auth_token, template_id, document_id)
+    Doccy::Documents.download(auth_token, template_id, document_id, original=nil)
 
+- if you past through original=true as a param if will return the document in the original format with the merges rather then in PDF.
 
 ## <a name="emails"> Emails </a>
 

data/doccy-api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Sentia Australia Pty Ltd"]
   spec.email         = ["support@doccyapp.com"]
   spec.summary       = "Ruby wrapper around Doccy API"
-  spec.description   = "Ruby wrapper around Doccy API for creating, sending and sharing documents. This api can be used if your a Doccy partner or just want to use Doccy in your app."
+  spec.description   = "Ruby wrapper around Doccy API for creating, sending and sharing documents. This api can be used if you're a Doccy partner or just want to use Doccy in your app."
   spec.homepage      = "https://www.doccyapp.com"
   spec.license       = "MIT"
 

data/lib/doccy/documents.rb

@@ -14,8 +14,12 @@ module Doccy
       response = HTTParty.get("#{Doccy::Config.url}/templates/#{template_id}/documents/#{document_id}.json", options)
     end
     
-    def self.download(auth_token, template_id, document_id)
-      options = { query: { auth_token: auth_token} }
+    def self.download(auth_token, template_id, document_id, original=nil)
+      if original
+        options = { query: { auth_token: auth_token, original: true} }
+      else
+        options = { query: { auth_token: auth_token} }
+      end
     
       response = HTTParty.get("#{Doccy::Config.url}/templates/#{template_id}/documents/#{document_id}/download.json", options)
     end

data/lib/doccy/version.rb

@@ -1,3 +1,3 @@
 module Doccy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doccy-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby wrapper around Doccy API for creating, sending and sharing documents.
-  This api can be used if your a Doccy partner or just want to use Doccy in your app.
+  This api can be used if you're a Doccy partner or just want to use Doccy in your
+  app.
 email:
 - support@doccyapp.com
 executables: []
@@ -137,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -80846182938457042
+      hash: 3458260510351561532
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -80846182938457042
+      hash: 3458260510351561532
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25