coda_docs 0.1.1

data/README.md

@@ -0,0 +1,48 @@
+# CodaDocs
+
+The Coda Docs Ruby library provides convenient access to the [Coda Docs API](https://coda.io/developers/apis/v1beta1) from applications written in the Ruby language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coda_docs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coda_docs
+
+## Usage
+
+The library needs to be configured with your account's secret key which is available in your [Coda Docs Dashboard](https://coda.io/account). You can set the required key with the `CODA_DOCS_API_KEY` environment variable
+
+```ruby
+CODA_DOCS_API_KEY=Vau7FXe57Ith6MxcMnT1QSzNZ0o1YZ8s
+
+# New Coda Docs Client
+client = CodaDocs::Client.new
+```
+ or at the moment we create a new client.
+
+```ruby
+require "coda_docs"
+
+# New Coda Docs Client
+client = CodaDocs::Client.new('Vau7FXe57Ith6MxcMnT1QSzNZ0o1YZ8s')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cmunozgar/coda_docs.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coda_docs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/coda_docs.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coda_docs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'coda_docs'
+  spec.version       = CodaDocs::VERSION
+  spec.authors       = ['Carlos Muñoz']
+  spec.email         = ['carlos@monday.vc']
+
+  spec.summary       = 'Coda Docs Api Gem'
+  spec.description   = 'Gem to help integrate Ruby <> Coda Docs API (0.1.1-beta). Work is still in progress and everything is subject to change.'
+  spec.homepage      = 'https://github.com/joinmonday/coda_docs'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'dotenv', '~> 2.5'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'httparty', '~> 0.16'
+end

data/lib/coda_docs.rb

@@ -0,0 +1,7 @@
+require 'httparty'
+require 'coda_docs/version'
+require 'coda_docs/client'
+
+module CodaDocs
+  # Your code goes here...
+end

data/lib/coda_docs/client.rb

@@ -0,0 +1,38 @@
+require 'coda_docs/client/docs'
+require 'coda_docs/client/sections'
+require 'coda_docs/client/folders'
+require 'coda_docs/client/tables'
+require 'coda_docs/client/rows'
+require 'coda_docs/client/columns'
+require 'coda_docs/client/formulas'
+require 'coda_docs/client/controls'
+require 'coda_docs/client/account'
+require 'coda_docs/client/miscellaneous'
+
+module CodaDocs
+  class Client
+    include HTTParty
+    include CodaDocs::Client::Docs
+    include CodaDocs::Client::Sections
+    include CodaDocs::Client::Folders
+    include CodaDocs::Client::Tables
+    include CodaDocs::Client::Rows
+    include CodaDocs::Client::Columns
+    include CodaDocs::Client::Formulas
+    include CodaDocs::Client::Controls
+    include CodaDocs::Client::Account
+    include CodaDocs::Client::Miscellaneous
+    base_uri 'https://coda.io/apis/v1beta1'
+    format :json
+
+    def initialize(access_token = nil)
+      access_token ||= ENV['CODA_DOCS_API_KEY']
+      self.class.default_options.merge!(
+        headers: {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => 'application/json'
+        }
+      )
+    end
+  end
+end

data/lib/coda_docs/client/account.rb

@@ -0,0 +1,9 @@
+module CodaDocs
+  class Client
+    module Account
+      def whoami
+        self.class.get('/whoami')
+      end
+    end
+  end
+end

data/lib/coda_docs/client/columns.rb

@@ -0,0 +1,14 @@
+module CodaDocs
+  class Client
+    module Columns
+      def columns(doc_id, table_id, options = {})
+        response = self.class.get("/docs/#{doc_id}/tables/#{table_id}/columns", query: options)
+        response.parsed_response['items']
+      end
+
+      def column(doc_id, table_id, column_id, options = {})
+        self.class.get("/docs/#{doc_id}/tables/#{table_id}/columns/#{column_id}", query: options)
+      end
+    end
+  end
+end

data/lib/coda_docs/client/controls.rb

@@ -0,0 +1,14 @@
+module CodaDocs
+  class Client
+    module Controls
+      def controls(doc_id, options = {})
+        response = self.class.get("/docs/#{doc_id}/controls", query: options)
+        response.parsed_response['items']
+      end
+
+      def formula(doc_id, control_id, options = {})
+        self.class.get("/docs/#{doc_id}/controls/#{control_id}", query: options)
+      end
+    end
+  end
+end

data/lib/coda_docs/client/docs.rb

@@ -0,0 +1,24 @@
+module CodaDocs
+  class Client
+    module Docs
+      def docs(options = {})
+        response = self.class.get('/docs', query: options)
+        response.parsed_response['items']
+      end
+
+      def doc(doc_id, options = {})
+        self.class.get("/docs/#{doc_id}", query: options)
+      end
+
+      def create_doc(title = 'Untitled', source_doc = nil)
+        self.class.post(
+          '/docs',
+          body: {
+            'title' => title,
+            'sourceDoc' => source_doc
+          }.to_json
+        )
+      end
+    end
+  end
+end

data/lib/coda_docs/client/folders.rb

@@ -0,0 +1,14 @@
+module CodaDocs
+  class Client
+    module Folders
+      def folders(doc_id, options = {})
+        response = self.class.get("/docs/#{doc_id}/folders", query: options)
+        response.parsed_response['items']
+      end
+
+      def folder(doc_id, folder_id, options = {})
+        self.class.get("/docs/#{doc_id}/folders/#{folder_id}", query: options)
+      end
+    end
+  end
+end

data/lib/coda_docs/client/formulas.rb

@@ -0,0 +1,14 @@
+module CodaDocs
+  class Client
+    module Formulas
+      def formulas(doc_id, options = {})
+        response = self.class.get("/docs/#{doc_id}/formulas", query: options)
+        response.parsed_response['items']
+      end
+
+      def formula(doc_id, formula_id, options = {})
+        self.class.get("/docs/#{doc_id}/formulas/#{formula_id}", query: options)
+      end
+    end
+  end
+end

data/lib/coda_docs/client/miscellaneous.rb

@@ -0,0 +1,9 @@
+module CodaDocs
+  class Client
+    module Miscellaneous
+      def resolve_browser_link(url, degrade_gracefully = true)
+        self.class.get('/resolveBrowserLink', query: { url: url, degradeGracefully: degrade_gracefully })
+      end
+    end
+  end
+end

data/lib/coda_docs/client/rows.rb

@@ -0,0 +1,18 @@
+module CodaDocs
+  class Client
+    module Rows
+      def rows(doc_id, table_id, options = {})
+        response = self.class.get("/docs/#{doc_id}/tables/#{table_id}/rows", query: options)
+        response.parsed_response['items']
+      end
+
+      def row(doc_id, table_id, row_id, options = {})
+        self.class.get("/docs/#{doc_id}/tables/#{table_id}/rows/#{row_id}", query: options)
+      end
+
+      def delete_row(doc_id, table_id, row_id)
+        self.class.delete("/docs/#{doc_id}/tables/#{table_id}/rows/#{row_id}")
+      end
+    end
+  end
+end

data/lib/coda_docs/client/sections.rb

@@ -0,0 +1,14 @@
+module CodaDocs
+  class Client
+    module Sections
+      def sections(doc_id, options = {})
+        response = self.class.get("/docs/#{doc_id}/sections", query: options)
+        response.parsed_response['items']
+      end
+
+      def section(doc_id, section_id, options = {})
+        self.class.get("/docs/#{doc_id}/sections/#{section_id}", query: options)
+      end
+    end
+  end
+end

data/lib/coda_docs/client/tables.rb

@@ -0,0 +1,14 @@
+module CodaDocs
+  class Client
+    module Tables
+      def tables(doc_id, options = {})
+        response = self.class.get("/docs/#{doc_id}/tables", query: options)
+        response.parsed_response['items']
+      end
+
+      def table(doc_id, table_id, options = {})
+        self.class.get("/docs/#{doc_id}/tables/#{table_id}", query: options)
+      end
+    end
+  end
+end

data/lib/coda_docs/version.rb

@@ -0,0 +1,3 @@
+module CodaDocs
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: coda_docs
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Carlos Muñoz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Gem to help integrate Ruby <> Coda Docs API (0.1.1-beta). Work is still
+  in progress and everything is subject to change.
+email:
+- carlos@monday.vc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coda_docs.gemspec
+- lib/coda_docs.rb
+- lib/coda_docs/client.rb
+- lib/coda_docs/client/account.rb
+- lib/coda_docs/client/columns.rb
+- lib/coda_docs/client/controls.rb
+- lib/coda_docs/client/docs.rb
+- lib/coda_docs/client/folders.rb
+- lib/coda_docs/client/formulas.rb
+- lib/coda_docs/client/miscellaneous.rb
+- lib/coda_docs/client/rows.rb
+- lib/coda_docs/client/sections.rb
+- lib/coda_docs/client/tables.rb
+- lib/coda_docs/version.rb
+homepage: https://github.com/joinmonday/coda_docs
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/joinmonday/coda_docs
+  source_code_uri: https://github.com/joinmonday/coda_docs
+  changelog_uri: https://github.com/joinmonday/coda_docs
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Coda Docs Api Gem
+test_files: []