doccy-api 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doccy-api.gemspec
+gemspec
+
+group :development do
+  # Testing
+  gem "rspec"
+  gem "rr"
+  gem "shoulda", ">= 0"
+  gem 'factory_girl_rails'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Cindric
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Doccy::Api
+Official Ruby wrapper for the https://www.doccyapp.com api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doccy-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doccy-api
+	
+## Usage
+
+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.app_key = "YOUR-PARTNER-KEY" #OPTIONAL you only need this to create client accounts.
+
+
+## Sections
+
+
+* [Accounts](#accounts)
+* [Templates](#templates)
+* [Documents](#documents)
+* [Emails](#emails)
+* [Login](#login)
+
+
+## <a name="accounts"> Accounts</a>
+
+Doccy Partners are able to create client accounts through their applications. To become a partner contact us at support@doccyapp.com for more information.
+
+Create an account and a user:
+  
+	Doccy::Accounts.create(company_name, user_name, email, password, options = {})
+  
+
+## <a name="templates"> Templates </a>
+
+Returns all Templates for that users account
+
+    Doccy::Templates.all(auth_token)
+    
+   
+Returns a specific Template
+    
+    Doccy::Templates.get(auth_token, template_id)
+
+
+Uploads a Teamplate to Doccy
+    
+    Doccy::Templates.upload(auth_token, template_params)
+
+
+## <a name="documents"> Documents </a>
+
+Creates a Document from Template
+
+    Doccy::Documents.create(auth_token, template_id, document_params)
+    
+Returns a specific Document
+  
+    Doccy::Documents.get(auth_token, template_id, document_id)
+
+
+Downloads a Document
+    
+    Doccy::Documents.download(auth_token, template_id, document_id)
+
+
+## <a name="emails"> Emails </a>
+
+Will send a document via Doccy
+
+	Doccy::Documents.create(auth_token, template_id, document_id, email_params)
+
+## <a name="login"> Login </a>
+
+This will return the auth_token for that user.
+
+	Doccy::Session.create(email, password)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/doccy-api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doccy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doccy-api"
+  spec.version       = Doccy::VERSION
+  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.homepage      = "https://www.doccyapp.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  
+  spec.add_dependency "httparty"
+  spec.add_dependency "json"
+  
+end

data/lib/doccy/accounts.rb

@@ -0,0 +1,16 @@
+module Doccy
+    
+  class Accounts
+    include HTTParty
+
+    def self.create(company_name, user_name, email, password, options = {})
+      receive_newsletter     = options.delete(:receive_newsletter) || true
+      
+      options = { query: { account: {company_name: company_name, user_name: user_name, email: email, password: password}, auth_token: Doccy::Config.partner_key } }
+      response = HTTParty.post("#{Doccy::Config.url}/partners/accounts.json", options)
+    end
+    
+    
+  end
+    
+end

data/lib/doccy/config.rb

@@ -0,0 +1,34 @@
+module Doccy
+  module Config
+    
+    class << self
+      attr_accessor :endpoints
+      attr_accessor :prefix
+      attr_accessor :partner_key
+      attr_accessor :app_secret
+      attr_accessor :mode
+    end
+    
+    self.endpoints = {
+      :development  => "http://localhost:3000",
+      :staging      => "http://staging.doccyapp.com",
+      :production   => "https://www.doccyapp.com"
+    }
+  
+    self.prefix      = "/1"
+    self.partner_key = nil
+    self.app_secret  = nil
+    self.mode        = :staging
+    
+    def self.url
+      if self.mode == :production
+        [self.endpoints[:production], "/api", self.prefix, ].join
+      elsif self.mode == :development
+        [self.endpoints[:development], "/api", self.prefix, ].join
+      else
+        [self.endpoints[:staging], "/api", self.prefix, ].join
+      end
+    end
+    
+  end
+end

data/lib/doccy/documents.rb

@@ -0,0 +1,25 @@
+module Doccy
+    
+  class Documents
+    
+    def self.create(auth_token, template_id, document_params)
+      options = { query: { auth_token: auth_token, document: document_params} }
+    
+      response = HTTParty.post("#{Doccy::Config.url}/templates/#{template_id}/documents.json", options)
+    end
+    
+    def self.get(auth_token, template_id, document_id)
+      options = { query: { auth_token: auth_token} }
+    
+      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} }
+    
+      response = HTTParty.get("#{Doccy::Config.url}/templates/#{template_id}/documents/#{document_id}/download.json", options)
+    end
+    
+  end
+    
+end

data/lib/doccy/emails.rb

@@ -0,0 +1,13 @@
+module Doccy
+    
+  class Emails
+    include HTTParty
+
+    def self.create(auth_token, template_id, document_id, email_params)
+      options = { query: { email: email_params, auth_token: auth_token} }
+      response = HTTParty.post("#{Doccy::Api::Config.url}/templates/#{template_id}/documents/#{document_id}/emails.json", options)
+    end
+    
+  end
+    
+end

data/lib/doccy/session.rb

@@ -0,0 +1,13 @@
+module Doccy
+    
+  class Session
+    include HTTParty
+
+    def self.create(email, password)
+      options = { query: { email: email, password: password } }
+      response = HTTParty.post("#{Doccy::Api::Config.url}/sessions.json", options)
+    end
+    
+  end
+    
+end

data/lib/doccy/templates.rb

@@ -0,0 +1,27 @@
+module Doccy
+  class Templates
+    
+    def self.all(auth_token)
+      options = { query: { auth_token: auth_token } }
+      
+      response = HTTParty.get("#{Doccy::Config.url}/templates.json", options)
+    end
+    
+    
+    def self.get(auth_token, template_id)
+      options = { query: { auth_token: auth_token } }
+      
+      response = HTTParty.get("#{Doccy::Config.url}/templates/#{template_id}.json", options)
+    end
+    
+    def self.upload(auth_token, template_params)
+      options = { query: { auth_token: auth_token , template: template_params} }
+      
+      response = HTTParty.post("#{Doccy::Config.url}/templates.json", options)
+      
+      # puts response.body
+    end
+    
+  end
+    
+end

data/lib/doccy/version.rb

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

data/lib/doccy.rb

@@ -0,0 +1,18 @@
+require 'logger'
+
+module Doccy
+  
+  autoload :Accounts,           "doccy/accounts"
+  autoload :Templates,          "doccy/templates"
+  autoload :Documents,          "doccy/documents"
+  autoload :Emails,             "doccy/emails"
+  autoload :Session,            "doccy/session"
+  autoload :Config,             "doccy/config"
+  autoload :VERSION,            "doccy/version"
+
+   
+  def self.logger
+    @logger ||= Logger.new(STDOUT).tap { |logger| logger.level = Logger::INFO }
+  end 
+  
+end

data/spec/api_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+require 'doccy'
+
+describe Doccy do
+end

data/spec/factories/account_factory.rb

@@ -0,0 +1,40 @@
+FactoryGirl.define do
+
+  factory :account do
+    sequence(:name) { |n| "Sentia_#{n}" }
+    expires_at 30.days.from_now
+    active true
+    plan_id ""
+    subscription_id ""
+    payment_token ""
+    api_key ""
+    secret ""
+
+    trait :dropbox_authenticated do
+      dropbox_oauth_token  "abc123"
+      dropbox_oauth_secret "def456"
+    end
+
+    trait :subscribed do
+      plan
+      subscription_id "abc123"
+    end
+
+    trait :expired do
+      expires_at 31.days.ago
+    end
+
+    trait :inactive do
+      active false
+    end
+
+    trait :with_owner do
+      association :owner, factory: :user
+    end
+
+    factory :subscribed_account, traits: [:subscribed, :with_owner]
+    factory :expired_account,    traits: [:expired, :subscribed]
+    factory :inactive_account,   traits: [:inactive, :subscribed]
+  end
+
+end

data/spec/factories/document_factory.rb

@@ -0,0 +1,14 @@
+include ActionDispatch::TestProcess
+
+FactoryGirl.define do
+
+  factory :document do
+    converted_document { fixture_file_upload("spec/templates/Word-Template.docx", "application/msword") }
+    content        {{"company-name"=>"b", "company-address"=>"c", "name"=>"d", "title"=>"e", "date"=>"f"}}
+    template_id     1
+    account
+    name           "Agreement for Client"
+  end
+
+
+end

data/spec/factories/email_factory.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+
+  factory :email do
+    sequence(:subject) { |n| "Sentia#{n}" }
+    message "A cool document"
+    recipients "michael.cindric@sentia.com.au"
+    pdf false
+  end
+
+end

data/spec/factories/partner_factory.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+
+  factory :partner do
+    sequence(:name) { |n| "name_#{n}" }
+    sequence(:auth_token) { |n| "token#{n}" }
+  end
+
+end

data/spec/factories/template_factory.rb

@@ -0,0 +1,24 @@
+include ActionDispatch::TestProcess
+
+FactoryGirl.define do
+
+  factory :docx_template, class: Template do
+    sequence(:name)   { |n| "docx_template#{n}" }
+    document_template { fixture_file_upload("spec/templates/Word-Template.docx", "application/msword") }
+    account
+  end
+
+  factory :pages_template, class: Template do
+    sequence(:name)   { |n| "pages_template#{n}" }
+    document_template { fixture_file_upload("spec/templates/Pages-Template.pages", "application/octet-stream") }
+    account
+  end
+
+  factory :blank_template, class: Template do
+    sequence(:name)   { |n| "blank_template#{n}" }
+    document_template { fixture_file_upload("spec/templates/blank.pages", "application/octet-stream") }
+    account
+  end
+
+
+end

data/spec/factories/user_factory.rb

@@ -0,0 +1,27 @@
+FactoryGirl.define do
+
+  factory :user do
+    sequence(:email) { |n| "dev#{n}@google.com" }
+    password "password"
+    password_confirmation "password"
+    name "Tony Stark"
+    account
+    majstor false
+
+    trait(:inactive) do
+      association :account, factory: :account, active: false
+    end
+
+    trait(:admin) do
+      majstor true
+    end
+
+    trait(:subscribed) do
+      association :account, factory: :subscribed_account
+    end
+
+    factory :admin,             traits: [:admin]
+    factory :subscribed_user,   traits: [:subscribed]
+  end
+
+end

data/spec/lib/account_spec.rb

@@ -0,0 +1,31 @@
+require 'api'
+require 'spec_helper'
+
+describe Doccy::Accounts do
+  
+  describe "with valid partner details" do
+
+    it "should create a client account with valid params" do
+      
+      
+      account = Doccy::Accounts.create "company_name", "user_name", "email", "password"
+    end
+    
+    it "should not create an client account with invalid params" do
+    
+    end
+    
+  end
+  
+  describe "with invalid partner details" do
+    
+    it "should not create an client account" do
+      response = mock :code => 403, :body => { error: "invalid_partner_account", 
+                                              error_description: "An unknown error has occurred."}
+     
+    end
+    
+  end
+  
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'doccy'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: doccy-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sentia Australia Pty Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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.
+email:
+- support@doccyapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doccy-api.gemspec
+- lib/doccy.rb
+- lib/doccy/accounts.rb
+- lib/doccy/config.rb
+- lib/doccy/documents.rb
+- lib/doccy/emails.rb
+- lib/doccy/session.rb
+- lib/doccy/templates.rb
+- lib/doccy/version.rb
+- spec/api_spec.rb
+- spec/factories/account_factory.rb
+- spec/factories/document_factory.rb
+- spec/factories/email_factory.rb
+- spec/factories/partner_factory.rb
+- spec/factories/template_factory.rb
+- spec/factories/user_factory.rb
+- spec/lib/account_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.doccyapp.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -80846182938457042
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -80846182938457042
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper around Doccy API
+test_files:
+- spec/api_spec.rb
+- spec/factories/account_factory.rb
+- spec/factories/document_factory.rb
+- spec/factories/email_factory.rb
+- spec/factories/partner_factory.rb
+- spec/factories/template_factory.rb
+- spec/factories/user_factory.rb
+- spec/lib/account_spec.rb
+- spec/spec_helper.rb