zoho-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fce71c3e8eef735279ca9f9061e4d9f6851b9873fa6908ced56643d19f4989f3
+  data.tar.gz: e9110fb93c90c904dd4841547f1c45a4637a15a5ea88888ebe027033643c80bc
+SHA512:
+  metadata.gz: 85dbad7fe201b5257c79ad6e25586a7870ba7a846390fb2dfbfa0fadf014c92920048ed80af03613eb5fff041a422ca5d36f4bf55fad8e99f40285353e598a7f
+  data.tar.gz: 2a4ecb2e716507b4c6127d353ffe03a8d41f2f2538de94bc976636f9a35998a865d8ed49f64effd3dca7b7b975f99243fc61b33d34cd9dfa0ceb552dadb2a3b4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+os: linux
+dist: xenial
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Zoho SDK changelog
+
+All notable changes to zoho-sdk will be documented in this file.
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/paulholden2/zoho-sdk/compare/9ebce10...HEAD

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "simplecov", "~> 0.17.1"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Paul Holden
+
+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,35 @@
+# Zoho SDK
+
+[![Build Status](https://travis-ci.org/paulholden2/zoho-sdk.svg?branch=master)](https://travis-ci.org/paulholden2/zoho-sdk) [![Inline docs](http://inch-ci.org/github/paulholden2/zoho-sdk.svg?branch=master)](http://inch-ci.org/github/paulholden2/zoho-sdk) [![Maintainability](https://api.codeclimate.com/v1/badges/c611ed65df2b9dc7834c/maintainability)](https://codeclimate.com/github/paulholden2/zoho-sdk/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c611ed65df2b9dc7834c/test_coverage)](https://codeclimate.com/github/paulholden2/zoho-sdk/test_coverage)
+
+A library for interacting with Zoho applications via REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zoho-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zoho-sdk
+
+## Usage
+
+Check back later.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/paulholden2/zoho-sdk.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

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 "zoho-sdk"
+
+# 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/lib/zoho-sdk.rb

@@ -0,0 +1,4 @@
+require "zoho-sdk/version"
+require "zoho-sdk/analytics"
+
+module ZohoSdk; end

data/lib/zoho-sdk/analytics.rb

@@ -0,0 +1,14 @@
+require "zoho-sdk/analytics/client"
+
+module ZohoSdk::Analytics
+  class Error < StandardError; end
+
+  class ColumnAlreadyExistsError < Error
+  end
+
+  class TableAlreadyExistsError < Error
+  end
+
+  class WorkspaceAlreadyExistsError < Error
+  end
+end

data/lib/zoho-sdk/analytics/client.rb

@@ -0,0 +1,75 @@
+require "faraday"
+require "json"
+require "zoho-sdk/analytics/workspace"
+
+module ZohoSdk::Analytics
+  API_HOSTNAME = "https://analyticsapi.zoho.com".freeze
+  API_PATH = "api".freeze
+  API_BASE_URL = "#{API_HOSTNAME}/#{API_PATH}".freeze
+
+  class Client
+    def initialize(email, auth_token)
+      @email = email
+      @auth_token = auth_token
+    end
+
+    def workspace_metadata
+      get params: {
+        "ZOHO_ACTION" => "DATABASEMETADATA",
+        "ZOHO_METADATA" => "ZOHO_CATALOG_LIST"
+      }
+    end
+
+    def create_workspace(name, **opts)
+      return if exists?
+      res = @client.get params: {
+        "ZOHO_ACTION" => "CREATEBLANKDB",
+        "ZOHO_DATABASE_NAME" => name,
+        "ZOHO_DATABASE_DESC" => opts[:description] || ""
+      }
+      if res.success?
+        data = JSON.parse(res.body)
+        Workspace.new(name, self)
+      else
+        nil
+      end
+    end
+
+    def workspace(name)
+      res = get params: {
+        "ZOHO_ACTION" => "ISDBEXIST",
+        "ZOHO_DB_NAME" => name
+      }
+      if res.success?
+        data = JSON.parse(res.body)
+        if data.dig("response", "result", "isdbexist") == "true"
+          Workspace.new(name, self)
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+
+    def get(path: nil, params: {})
+      parts = [API_BASE_URL, @email]
+      if !path.nil?
+        if path[0] == "/"
+          path = path[1..-1]
+        end
+        parts << path
+      end
+      conn = Faraday.new(url: parts.join("/"))
+      res = conn.get do |req|
+        req.params["ZOHO_OUTPUT_FORMAT"] = "JSON"
+        req.params["ZOHO_ERROR_FORMAT"] = "JSON"
+        req.params["ZOHO_API_VERSION"] = "1.0"
+        req.params["authtoken"] = @auth_token
+        params.each { |key, value|
+          req.params[key] = value
+        }
+      end
+    end
+  end
+end

data/lib/zoho-sdk/analytics/column.rb

@@ -0,0 +1,27 @@
+module ZohoSdk::Analytics
+  class Column
+    DATA_TYPES = {
+      "Auto" => :system,
+      "Plain Text" => :plain,
+      "E-Mail" => :email,
+      "Multi Line Text" => :multi,
+      "URL" => :url,
+      "Number" => :number,
+      "Auto Number" => :auto_number,
+      "Positive Number" => :positive_number,
+      "Decimal Number" => :decimal_number,
+      "Currency" => :currency,
+      "Percentage" => :percentage,
+      "Date" => :date,
+      "Yes/No Decision" => :boolean
+    }.freeze
+
+    attr_reader :name, :table
+
+    def initialize(name, table, client)
+      @name = name
+      @table = table
+      @client = client
+    end
+  end
+end

data/lib/zoho-sdk/analytics/table.rb

@@ -0,0 +1,155 @@
+require "zoho-sdk/analytics/column"
+require "uri"
+
+module ZohoSdk::Analytics
+  class Table
+    IMPORT_TYPES = {
+      :append => "APPEND",
+      :truncate_add => "TRUNCATEADD",
+      :update_add => "UPDATEADD"
+    }.freeze
+
+    attr_reader :workspace
+    attr_reader :columns
+    attr_reader :client
+
+    def initialize(table_name, workspace, client, columns: [])
+      @table_name = table_name
+      @workspace = workspace
+      @client = client
+      @columns = columns
+      @exists
+    end
+
+    def name
+      @table_name
+    end
+
+    def create_column(column_name, type, **opts)
+      if !Column::DATA_TYPES.values.include?(type)
+        raise ArgumentError.new("Column type must be one of: #{Column::DATA_TYPES.values.join(', ')}")
+      end
+      @type = type
+      @required = opts[:required] || false
+      @description = opts[:description] || ""
+      res = client.get path: "#{workspace.name}/#{URI.encode(name)}", params: {
+        "ZOHO_ACTION" => "ADDCOLUMN",
+        "ZOHO_COLUMNNAME" => column_name,
+        "ZOHO_DATATYPE" => type.to_s.upcase
+      }
+      if res.success?
+        data = JSON.parse(res.body)
+        Column.new(column_name, self, client)
+      else
+        nil
+      end
+    end
+
+    def column(name)
+      res = client.get path: "#{workspace.name}/#{URI.encode(name)}", params: {
+        "ZOHO_ACTION" => "ISCOLUMNEXIST",
+        "ZOHO_COLUMN_NAME" => name
+      }
+      if res.success?
+        data = JSON.parse(res.body)
+        if data.dig("response", "result", "iscolumnexist") == "true"
+          col = Column.new(name, self, client)
+          @columns << col
+          col
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+
+    def rows
+      res = client.get path: "#{workspace.name}/#{name}", params: {
+        "ZOHO_ACTION" => "EXPORT"
+      }
+    end
+
+    def import(import_type, data, **opts)
+      if !IMPORT_TYPES.keys.include?(import_type)
+        raise ArgumentError.new("import_type must be one of: #{IMPORT_TYPES.keys.join(', ')}")
+      end
+
+      params = {
+        "ZOHO_ACTION" => "IMPORT",
+        "ZOHO_IMPORT_DATA" => data.to_json,
+        "ZOHO_IMPORT_TYPE" => IMPORT_TYPES[import_type],
+        "ZOHO_IMPORT_FILETYPE" => "JSON",
+        "ZOHO_ON_IMPORT_ERROR" => "ABORT",
+        "ZOHO_CREATE_TABLE" => "false",
+        "ZOHO_AUTO_IDENTIFY" => "false"
+      }
+
+      if import_type == :update_add
+        matching = opts[:matching] || []
+        if !matching.is_a?(Array) || matching.size < 1
+          raise ArgumentError.new("Must pass at least one column in `matching` option for UPDATEADD")
+        end
+
+        params["ZOHO_MATCHING_COLUMNS"] = matching.join(',')
+      end
+
+      res = client.get path: "#{workspace.name}/#{name}", params: params
+      if res.success?
+        data = JSON.parse(res.body)
+        data.dig("response", "result", "importSummary", "successRowCount")
+      else
+        nil
+      end
+    end
+
+    def delete(criteria)
+      if criteria.nil?
+        raise ArgumentError.new("Delete criteria must be specified")
+      end
+
+      delete!(criteria)
+    end
+
+    def delete!(criteria = nil)
+      params = {
+        "ZOHO_ACTION" => "DELETE"
+      }
+
+      params["ZOHO_CRITERIA"] = criteria if !criteria.nil?
+
+      res = client.get path: "#{workspace.name}/#{name}", params: params
+      if res.success?
+        data = JSON.parse(res.body)
+        data.dig("response", "result", "deletedrows").to_i
+      else
+        nil
+      end
+    end
+
+    def <<(row)
+      params = { "ZOHO_ACTION" => "ADDROW" }
+      restricted = %w(
+        ZOHO_ACTION
+        ZOHO_API_VERSION
+        ZOHO_OUTPUT_FORMAT
+        ZOHO_ERROR_FORMAT
+        authtoken
+      )
+
+      params = row.reject { |key|
+        !key.is_a?(String) || restricted.include?(key)
+      }.merge(params)
+
+      res = client.get path: "#{workspace.name}/#{name}", params: params
+      if res.success?
+        data = JSON.parse(res.body)
+        columns = data.dig("response", "result", "column_order")
+        values = data.dig("response", "result", "rows", 0)
+        columns.zip(values).to_h
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/zoho-sdk/analytics/workspace.rb

@@ -0,0 +1,72 @@
+require "zoho-sdk/analytics/table"
+
+module ZohoSdk::Analytics
+  class Workspace
+    attr_reader :client
+
+    def initialize(workspace_name, client)
+      @workspace_name = workspace_name
+      @client = client
+      @metadata = nil
+    end
+
+    def name
+      @workspace_name
+    end
+
+    def metadata
+      return @metadata if !@metadata.nil?
+      metadata!
+    end
+
+    def metadata!
+      res = client.get path: name, params: {
+        "ZOHO_ACTION" => "DATABASEMETADATA",
+        "ZOHO_METADATA" => "ZOHO_CATALOG_INFO"
+      }
+      if res.success?
+        data = JSON.parse(res.body)
+        @metadata = data.dig("response", "result")
+        @metadata
+      else
+        nil
+      end
+    end
+
+    def create_table(table_name, folder, **opts)
+      table_design = {
+        "TABLENAME" => table_name,
+        "TABLEDESCRIPTION" => opts[:description] || "",
+        "FOLDERNAME" => folder || "",
+        "COLUMNS" => []
+      }.to_json
+      res = client.get path: name, params: {
+        "ZOHO_ACTION" => "CREATETABLE",
+        "ZOHO_TABLE_DESIGN" => table_design
+      }
+      if res.success?
+        data = JSON.parse(res.body)
+        Table.new(name, self, client)
+      else
+        nil
+      end
+    end
+
+    def table(table_name)
+      res = client.get path: name, params: {
+        "ZOHO_ACTION" => "ISVIEWEXIST",
+        "ZOHO_VIEW_NAME" => table_name
+      }
+      if res.success?
+        data = JSON.parse(res.body)
+        if data.dig("response", "result", "isviewexist") == "true"
+          Table.new(table_name, self, client)
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/zoho-sdk/version.rb

@@ -0,0 +1,3 @@
+module ZohoSdk
+  VERSION = "0.1.0"
+end

data/zoho-sdk.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zoho-sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name  = "zoho-sdk"
+  spec.version = ZohoSdk::VERSION
+  spec.authors = ["Paul Holden"]
+  spec.email = ["pholden@stria.com"]
+
+  spec.summary = "A library for interacting with Zoho applications via REST API."
+  spec.description = "A library for interacting with Zoho applications via REST API."
+  spec.homepage = "https://github.com/paulholden2/zoho-sdk"
+  spec.license = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/paulholden2/zoho-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/paulholden2/zoho-sdk/blob/master/CHANGELOG.md"
+
+  # 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('..', __FILE__)) 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_dependency "faraday", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sinatra", "~> 2.0"
+  spec.add_development_dependency "webmock", "~> 3.6"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: zoho-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Holden
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A library for interacting with Zoho applications via REST API.
+email:
+- pholden@stria.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zoho-sdk.rb
+- lib/zoho-sdk/analytics.rb
+- lib/zoho-sdk/analytics/client.rb
+- lib/zoho-sdk/analytics/column.rb
+- lib/zoho-sdk/analytics/table.rb
+- lib/zoho-sdk/analytics/workspace.rb
+- lib/zoho-sdk/version.rb
+- zoho-sdk.gemspec
+homepage: https://github.com/paulholden2/zoho-sdk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/paulholden2/zoho-sdk
+  source_code_uri: https://github.com/paulholden2/zoho-sdk
+  changelog_uri: https://github.com/paulholden2/zoho-sdk/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: A library for interacting with Zoho applications via REST API.
+test_files: []