zoho_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0afebc24d463ec69d604aad39a205d58f73df247a79bc19fc0d8cf81b0bbfe0
+  data.tar.gz: 276372c86e9964d22742f490817034402cfa09b3e6ec901478d5e20b7577c09d
+SHA512:
+  metadata.gz: 634c9cb91eb215ae71ca59f0f1aaabd7b11df21a7009ffdb5caf02fcb6e039140e0aa802f5d82c31b17552459c155724d666803e16b9a0058d290a53f208c4b8
+  data.tar.gz: 9188400c80661801c3828badd66d8a7efbd7f12a757823a1ac8e35c35d242b7030e246394957bc71f5fbd4c961dfb86fe4ab6be9c164bb747ca0bf3539d7f98c

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zoho_tools.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'rest-client', '> 2'
+gem 'webmock', '> 3'

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    zoho_tools (0.1.0)
+      rest-client (> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    mime-types (3.5.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.0808)
+    netrc (0.11.0)
+    public_suffix (5.0.3)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rest-client (> 2)
+  rspec (~> 3.0)
+  webmock (> 3)
+  zoho_tools!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Lubomir Vnenk
+
+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,40 @@
+# ZohoTools
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zoho_tools`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zoho_tools'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install zoho_tools
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/zoho_tools.
+
+
+## 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_tools"
+
+# 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/changelog.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1
+Basic api created

data/lib/zoho_tools/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ZohoTools
+  class Configuration
+    attr_accessor :client_id, :client_secret, :campaigns_api_url, :accounts_api_url, :callback_url
+
+    def initialize
+      @client_secret = ENV['ZOHO_CLIENT_SECRET']
+      @client_id = ENV['ZOHO_CLIENT_ID']
+      @accounts_api_url = ENV['ZOHO_ACCOUNTS_API_URL']
+      @campaigns_api_url = ENV['ZOHO_CAMPAIGNS_API_URL']
+      @callback_url = ENV['ZOHO_CALLBACK_URL']
+    end
+  end
+end

data/lib/zoho_tools/list_management.rb

@@ -0,0 +1,28 @@
+module ZohoTools
+  class ListManagement
+    SUBSCRIBE_URL = '/api/v1.1/json/listsubscribe'.freeze
+    UNSUBSCRIBE_URL = '/api/v1.1/json/listunsubscribe'.freeze
+
+    def self.subscribe(access_token:, list_key:, contact_info:, topic_id: nil, source: nil)
+      params = { listkey: list_key, resfmt: 'JSON', contactinfo: contact_info.to_json }
+      params = params.merge(source: source) if source
+      params = params.merge(topic_id: topic_id) if topic_id
+
+      response = RestClient.post(URI.join(ZohoTools.config.campaigns_api_url, SUBSCRIBE_URL).to_s,
+                                 params,
+                                 { 'Authorization': "Zoho-oauthtoken #{access_token}" })
+      ZohoTools::Response.new(response)
+
+    end
+
+    def self.unsubscribe(access_token:, list_key:, contact_info:, topic_id: nil)
+      params = { listkey: list_key, resfmt: 'JSON', contactinfo: contact_info.to_json }
+      params = params.merge(topic_id: topic_id) if topic_id
+
+      response = RestClient.post(URI.join(ZohoTools.config.campaigns_api_url, UNSUBSCRIBE_URL).to_s,
+                                 params,
+                                 { 'Authorization': "Zoho-oauthtoken #{access_token}" })
+      ZohoTools::Response.new(response)
+    end
+  end
+end

data/lib/zoho_tools/mock/spec_helper.rb

@@ -0,0 +1,23 @@
+module ZohoTools
+  module SpecHelper
+    class Interface
+      def stub_refresh_access_tokens(refresh_token, access_token:)
+        stub_request(:post, URI.join(ZohoTools.config.accounts_api_url, '/oauth/v2/token'))
+          .with(body: hash_including(client_id: ZohoTools.config.client_id,
+                                     client_secret: ZohoTools.config.client_secret,
+                                     refresh_token: refresh_token,
+                                     grant_type: 'refresh_token'))
+          .to_return(status: 200,
+                     body: { access_token: access_token,
+                             scope: 'ZohoCampaigns.campaign.ALL ZohoCampaigns.contact.ALL',
+                             api_domain: 'https://www.zohoapis.eu',
+                             token_type: 'Bearer',
+                             expires_in: 3600 }.to_json)
+      end
+    end
+
+    def zoho_tools
+      @zoho_tools ||= Interface.new
+    end
+  end
+end

data/lib/zoho_tools/oauth.rb

@@ -0,0 +1,34 @@
+module ZohoTools
+  class Oauth
+    OAUTH_URL = '/oauth/v2/auth'.freeze
+    TOKEN_URL = '/oauth/v2/token'.freeze
+
+    def self.authorize(access_type: 'offline', scope: %w[ZohoCampaigns.campaign.ALL ZohoCampaigns.contact.ALL])
+      uri = URI.join(ZohoTools.config.accounts_api_url, OAUTH_URL)
+      uri.query = URI.encode_www_form(self.auth_params.merge({ redirect_uri: ZohoTools.config.callback_url,
+                                                               access_type: access_type,
+                                                               response_type: 'code',
+                                                               scope: scope.join(',') }))
+      uri.to_s
+    end
+
+    def self.authorization_code(code)
+      response = RestClient.post(URI.join(ZohoTools.config.accounts_api_url, TOKEN_URL).to_s,
+                                 self.auth_params.merge(code: code, grant_type: 'authorization_code', redirect_uri: ZohoTools.config.callback_url),
+                                 { accept: :json })
+      ZohoTools::Response.new(response)
+    end
+
+    def self.refresh_access_token(refresh_token)
+      response = RestClient.post(URI.join(ZohoTools.config.accounts_api_url, TOKEN_URL).to_s,
+                                 self.auth_params.merge(refresh_token: refresh_token, grant_type: 'refresh_token'),
+                                 { accept: :json })
+      ZohoTools::Response.new(response)
+    end
+
+    def self.auth_params
+      { client_id: ZohoTools.config.client_id,
+        client_secret: ZohoTools.config.client_secret }
+    end
+  end
+end

data/lib/zoho_tools/response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ZohoTools
+  class Response
+    attr_accessor :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def success?
+      response.code == 200 && (!body['status'] || body['status'] == 'success') && !body['error']
+    end
+
+    def error_message
+      return body['error'] if response.code == 200
+
+      response.message
+    end
+
+    def body
+      @body ||= JSON.parse(response.body)
+    end
+  end
+end

data/lib/zoho_tools/version.rb

@@ -0,0 +1,3 @@
+module ZohoTools
+  VERSION = '0.1.0'
+end

data/lib/zoho_tools.rb

@@ -0,0 +1,22 @@
+require 'rest-client'
+
+require 'zoho_tools/configuration'
+require 'zoho_tools/list_management'
+require 'zoho_tools/response'
+require 'zoho_tools/version'
+require 'zoho_tools/oauth'
+
+module ZohoTools
+  @configuration = Configuration.new
+
+  def self.config
+    @configuration
+  end
+
+  def self.configure
+    yield(@configuration)
+  end
+
+  class Error < StandardError
+  end
+end

data/zoho_tools.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/zoho_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zoho_tools"
+  spec.version       = ZohoTools::VERSION
+  spec.authors       = ["Lubomir Vnenk"]
+  spec.email         = ["lubomir.vnenk@zoho.com"]
+
+  spec.summary       = %q{ZOHO auth and subscriptions}
+  spec.description   = %q{ZOHO auth and subscriptions}
+  spec.homepage      = "https://github.com/lubosch/zoho_tools"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lubosch/zoho_tools"
+  spec.metadata["changelog_uri"] = "https://github.com/lubosch/zoho_tools"
+
+  # 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 'rest-client', '> 2'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: zoho_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lubomir Vnenk
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: ZOHO auth and subscriptions
+email:
+- lubomir.vnenk@zoho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog.md
+- lib/zoho_tools.rb
+- lib/zoho_tools/configuration.rb
+- lib/zoho_tools/list_management.rb
+- lib/zoho_tools/mock/spec_helper.rb
+- lib/zoho_tools/oauth.rb
+- lib/zoho_tools/response.rb
+- lib/zoho_tools/version.rb
+- zoho_tools.gemspec
+homepage: https://github.com/lubosch/zoho_tools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lubosch/zoho_tools
+  source_code_uri: https://github.com/lubosch/zoho_tools
+  changelog_uri: https://github.com/lubosch/zoho_tools
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: ZOHO auth and subscriptions
+test_files: []