zoho_reports 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODFiZDdmMmJhNjc3NTRhOTRiNDI5YTYyMWZlMWE5NWM2YjdmMGE4OQ==
+  data.tar.gz: !binary |-
+    NGQ1MTk5NmYxNTUwOTNjYmJjMDQ1YjQ2NDU1Mjk0OTZmMjcwNGQzMg==
+SHA512:
+  metadata.gz: !binary |-
+    ZDA5OGZjYzQyNzM1YzA0NDI5MzczYTFjYjY5YTM1MWE2NmQ4YWNjNmI2YzBk
+    YWMzNzVmNmFhNmZhYmVjZjgxOTNkMmNmOThiOTA0ZTZkY2E3NmFlNjg3MWM3
+    NGNlMDEzMTMxNGE3YmNjYjIwNTg5NGEzYzg2Y2Q5Nzc5OWFkNDg=
+  data.tar.gz: !binary |-
+    Y2EwYTgzNGY0NTM2ZWUyNzk3ZmNiMzQ5NDk0MTQwMTA1ZjI4MjY3NGE1ZTU3
+    NzRmNGU1ZjMyMGY0OWY2NzBlOTMyNDUyZDNlNThmMmVjMzUwODMwMTM4YWQ1
+    NzRmMzlhNWFiNTA3NDg4MjljZTIyY2YyNTMwMzZiOGI5OGFlMDg=

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zoho_reports.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 neil
+
+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,79 @@
+# ZohoReports
+
+Wraps the raw HTTP based API of Zoho Reports with easy to use methods for the ruby platform. This enables ruby and Rails developers to easily use Zoho Reports API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zoho_reports'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zoho_reports
+
+## Usage
+
+### Setting auth_token and login_email
+```ruby
+# (usually in /config/intializers/zoho_reports.rb)
+ZohoReports.configure do |config|
+  config.auth_token = 'token'
+  config.login_email = 'user@example.com'
+  config.database_name = 'test_database'
+end
+```
+
+### Initializing an instance
+```ruby
+client = ZohoReports::Client.new
+```
+
+### Importing an entire model
+This example shows how to import the "Widget" model records, including creating a table if it doesn't already exist. 
+
+```ruby
+# Notice the ZOHO_DATE_FORMAT here
+client.import_data(
+  "test_database", 
+  "widgets", 
+  'UPDATEADD', 
+  Widget.all.to_json, 
+  'ZOHO_MATCHING_COLUMNS' => 'id', 
+  'ZOHO_CREATE_TABLE' => 'true', 
+)
+
+```
+
+When importing through the API and generating a new table, string and datetime date types import correctly with format. However, here are the steps provided through the [Zoho Reports wiki comments](https://zohoreportsapi.wiki.zoho.com/importing-bulk-data.html) in case you have an issue with the column format:
+
+1. Login into Zoho Reports, Open the import wizard ( "Import Excel, CSV, HTML, Google docs,.." ), upload your file.
+2. Click "Next" button to go to the next screen of import wizard (i.e step 2 of 2), there you can see the preview table. 
+3. In that table, the first row will be header row ( i.e., Column names ) and the second row will be the datatype which is auto identified by our Zoho Reports system. There you can change the column datatype to "Text" for the column you want to change. Then, continue the import process.
+
+### Rails / ActiveRecord Support
+ZohoReports includes a module specific to ActiveReports that may be used as follows:
+
+```ruby
+# /app/models/widget.rb
+class Widget < ActiveRecord::Base
+  zoho_reportify
+...
+end
+```
+
+This adds two things to your Rails app.
+1. Widget.intialize_zoho_table will create the database table based on Widget.table_name and load all of the current data into it
+2. Adds an after_save callback that stores the instance attributes into the Zoho Reports table keeping your data in sync
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/zoho_reports/fork )
+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,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/zoho_reports/client.rb

@@ -0,0 +1,245 @@
+require "addressable/uri"
+require "httmultiparty"
+
+module ZohoReports
+  class Client
+    include HTTMultiParty
+
+    # ZohoReports provides the ruby based language binding to the http based api of ZohoReports.
+
+    attr_accessor :auth_token, :login_email, :api_version
+
+    base_uri "reportsapi.zoho.com:443/api"
+
+    def initialize
+      self.api_version = '1.0'
+    end
+
+    # Returns default settings for url query string on requests
+    def default_query
+      {
+        'authtoken' => ZohoReports.configuration.auth_token,
+        'ZOHO_OUTPUT_FORMAT' => 'JSON',
+        'ZOHO_ERROR_FORMAT' => 'JSON',
+        'ZOHO_API_VERSION' => self.api_version,
+      }
+    end
+
+    def send_request(url, http_method, options = {})
+      # Merge our default query string values with the specificed query values
+      options[:query] = default_query.merge!(options[:query])
+      
+      #Convert form variables to encoded string if exists
+      if options.has_key?(:body)
+        uri = Addressable::URI.new
+        uri.query_values = options[:body]
+        options[:body] = uri.query
+      end
+
+      response = self.class.send(http_method,url, options)
+
+      if response.success?
+        response
+      else
+        raise response.parsed_response
+      end
+    end
+
+    # Gets copy database key for specified database identified by the URI    
+    def get_copy_db_key
+      # payLoad = ReportClientHelper.getAsPayLoad([config],None,None)
+      options = {
+        :query => { 'ZOHO_ACTION' => 'GETCOPYDBKEY' }
+      } 
+
+      send_request get_db_uri, 'post', options
+    end
+
+    # Copy the specified database identified by the URI
+    def copy_database
+      options = {
+        :query => { 'ZOHO_ACTION' => 'COPYDATABASE' }
+      }
+
+      send_request get_db_uri, 'post', options
+    end
+
+    # Delete the specified database
+    def delete_database
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'DELETEDATABASE',
+          'ZOHO_DATABASE_NAME' => database_name,
+        }
+      }
+      send_request get_user_uri, 'post', options
+    end
+ 
+    # Add the users to the Zoho Reports Account
+    def add_user(email_ids)
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'ADDUSER',
+          'ZOHO_EMAILS' => email_ids,
+        }
+      }
+
+      send_request get_user_uri, 'post', options
+    end
+ 
+    # Remove the users from the Zoho Reports Account
+    def remove_user(email_ids)
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'REMOVEUSER',
+          'ZOHO_EMAILS' => email_ids,
+        }
+      }
+
+      send_request get_user_uri, 'post', options
+    end
+ 
+    # Activate the users in the Zoho Reports Account
+    def activate_user(email_ids)
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'ACTIVATEUSER',
+          'ZOHO_EMAILS' => email_ids,
+        }
+      }
+
+      send_request get_user_uri, 'post', options
+    end
+ 
+    # Deactivate the users in the Zoho Reports Account
+    def deactivate_user(email_ids)
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'DEACTIVATEUSER',
+          'ZOHO_EMAILS' => email_ids,
+        }
+      }
+
+      send_request get_user_uri, 'post', options
+    end
+
+    # Adds a row to the specified table identified by the URI
+    def add_row(table_name, column_values)
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'ADDROW',
+        },
+        :body => column_values
+      }
+
+      send_request get_uri(table_name), 'post', options
+    end
+    
+    # Update the data in the specified table identified by the URI.
+    def update_data(table_name, column_values, criteria, config={})
+      body = column_values.merge!({:ZOHO_CRITERIA => criteria})
+      body = body.merge!(config) if config.any?
+
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'UPDATE',
+        },
+        :body => body
+      }
+
+      send_request get_uri(table_name), 'post', options
+    end
+
+    # Delete the data in the specified table identified by the URI.
+    def delete_data(table_name, criteria, config={})
+      body = {'ZOHO_CRITERIA' => criteria}
+      body = body.merge!(config) if config.present?
+
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'DELETE',
+        },
+        :body => body
+      }
+
+      send_request get_uri(table_name), 'post', options
+    end
+
+    # Export the data in the specified table identified by the URI.
+    def export_data(table_or_report_name, format, criteria, config={})
+      body = {'ZOHO_CRITERIA' => criteria}
+      body = body.merge!(config) if config.present?
+
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'EXPORT',
+          'ZOHO_OUTPUT_FORMAT' => format,
+        },
+        :body => body
+      }
+
+      result = send_request get_uri(table_or_report_name), 'post', options
+      result
+      # TODO: Figure out to what to do with File objects response
+    end
+
+    # Export the data with the specified SQL query identified by the URI.
+    def export_data_using_sql(table_or_report_uri, format, sql, config={})
+      body = {'ZOHO_SQLQUERY' => sql}
+      body = body.merge!(config) if config.present?
+
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'EXPORT',
+          'ZOHO_OUTPUT_FORMAT' => format,
+        },
+        :body => body
+      }
+
+      result = send_request get_uri(table_or_report_name), 'post', options
+      result
+      # TODO: Figure out to what to do with File objectsw response
+    end        
+
+    # Bulk import data into the table identified by the URI.
+    def import_data(table_name, import_type, import_content, import_config={})
+      raise "Import Type must be APPEND, TRUNCATEADD or UPDATEADD" unless ["APPEND", "TRUNCATEADD", "UPDATEADD"].include?(import_type)
+
+      body = {
+        'ZOHO_AUTO_IDENTIFY' => 'true',
+        'ZOHO_ON_IMPORT_ERROR' => 'ABORT',
+        'ZOHO_CREATE_TABLE' => 'false',
+        'ZOHO_IMPORT_TYPE' => import_type,
+        'ZOHO_IMPORT_DATA' => import_content,
+        'ZOHO_IMPORT_FILETYPE' => 'JSON',
+        'ZOHO_MATCHING_COLUMNS' => 'id', 
+      }
+      body = body.merge!(import_config) if import_config.any?
+
+      options = {
+        :query => {
+          'ZOHO_ACTION' => 'IMPORT',
+        },
+        :body => body
+      }
+
+      send_request get_uri(table_name), 'post', options
+      # TODO: Figure out to what to do with File objectsw response
+    end        
+
+    # Returns the URI for the specified database table (or report).
+    def get_uri(table_or_report_name)
+      "/#{URI.encode ZohoReports.configuration.login_email}/#{URI.encode ZohoReports.configuration.zoho_database_name}/#{URI.encode table_or_report_name}"
+    end        
+
+    # Returns the URI for the specified database 
+    def get_db_uri
+      "#{URI.encode ZohoReports.configuration.login_email}/#{URI.encode ZohoReports.configuration.zoho_database_name}"
+    end
+
+    # Returns the URI for the specified user 
+    def get_user_uri
+      "/#{URI.encode ZohoReports.configuration.login_email}"
+    end
+  end
+end

data/lib/zoho_reports/configuration.rb

@@ -0,0 +1,11 @@
+module ZohoReports
+  class Configuration
+    attr_accessor :login_email, :auth_token, :zoho_database_name
+
+    def initialize
+      @login_email = ''
+      @auth_token = ''
+      @zoho_database_name = ''
+    end
+  end
+end

data/lib/zoho_reports/version.rb

@@ -0,0 +1,3 @@
+module ZohoReports
+  VERSION = "0.0.3"
+end

data/lib/zoho_reports/zoho_reportify.rb

@@ -0,0 +1,53 @@
+require 'active_support'
+require 'active_support/concern'
+require 'active_record'
+
+
+module ZohoReports
+  module ZohoReportify
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def zoho_reportify(options = {})
+        after_save :save_zoho_record
+
+        def self.initialize_zoho_table
+          client = ZohoReports::Client.new
+
+          client.import_data(
+            self.table_name, 
+            'UPDATEADD', 
+            all.to_json, 
+            'ZOHO_CREATE_TABLE' => 'true', 
+          )          
+        end
+
+        include ZohoReports::ZohoReportify::LocalInstanceMethods
+      end
+    end
+
+    module LocalInstanceMethods
+      def save_zoho_record
+        client = ZohoReports::Client.new
+
+        # Notice the ZOHO_DATE_FORMAT here
+        client.import_data(
+          self.class.table_name, 
+          'UPDATEADD', 
+          self.class.where(id: id).to_json, 
+        )
+
+        # Turn standard json back on
+        
+      end
+    end
+  end
+end
+
+# Extend ActiveRecord's functionality
+ActiveRecord::Base.send :include, ZohoReports::ZohoReportify
+
+# ActiveRecord::Base.send :extend, ZohoReportify

data/lib/zoho_reports.rb

@@ -0,0 +1,16 @@
+require "zoho_reports/version"
+require "zoho_reports/client"
+require "zoho_reports/configuration"
+require "zoho_reports/zoho_reportify"
+
+module ZohoReports
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+end

data/spec/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/widget.rb

@@ -0,0 +1,3 @@
+class Widget < ActiveRecord::Base
+  zoho_reportify
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "zoho_reports"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000