ragic_client 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95cef99984d3af55b1dd0cd49407c5220fdc0c775a843517624381dd87526c6c
+  data.tar.gz: e4bf487182f310b08ded26e3545ba015becbea09bfbe20c06bf983573d7ef153
+SHA512:
+  metadata.gz: ecabeae056f53d1b442d5658d607b7f442be551eb0fdde7343c39a97e23e6797925c1e302fc0f872fb114ba4cb35298a9a182eafe4286e42f1fae8d7a95ca161
+  data.tar.gz: d7d10fd25c9b956fb1493fa530d226088a057a17ed2c12228cc78a40d804db826b810e6c6fe51c75015cdbd8c6d5a7ed7f50c0856f0cc7ad74fe3d6b05543c19

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ragic_client.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "httparty"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    ragic_client (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  ragic_client!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,102 @@
+# RagicClient
+
+RagicClient is a simple tool integrate with [Ragic System](https://ragic.com). It's free and quite easy to use :smile: .
+
+[Ragic HTTP API Integration Guide](https://www.ragic.com/intl/en/doc-api).
+
+# Features
+
+- **[Create Entry](#create-entry)**
+- **[Update Entry](#update-entry)**
+- **[Delete Entry](#delete-entry)**
+- **[Find Entry By ID](#find-entry-by-id)**
+- **[Find Entry By Field ID And Value](#find-entry-by-field-id-and-value)**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ragic_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ragic_client
+
+## Usage
+
+### Config
+
+First thing you need to set up is placing something like this either in initializer or in application.rb file:
+
+```ruby
+  RagicClient.config do |config|
+    config.ragic_api_url = 'your ragic_api_url'
+    config.ragic_api_key = 'Basic your_ragic_api_key'
+  end
+```
+
+**Note: What you need to do is use the field ids of the fields as name, and the values that you want to insert as parameter values.**
+
+See here [Ragic API Documents](https://www.ragic.com/intl/en/doc-api/15/Creating-a-New-Entry).
+
+### Create Entry
+
+```ruby
+  params = {
+    '1000001' => 'Project Name',
+    '1000002' => '15000'
+  }
+  RagicClient.create params
+```
+
+### Update Entry
+
+```ruby
+  ragic_id = 1
+  params = {
+    '1000001' => 'Project Name Update'
+  }
+  RagicClient.update ragic_id, params
+```
+
+### Delete Entry
+
+```ruby
+  RagicClient.delete 1
+```
+
+### Find Entry by id
+
+```ruby
+  RagicClient.find 1
+```
+
+### Find Entry by field id and value
+
+```ruby
+  RagicClient.find_by { '1000001' => 'Project Name' }
+```
+
+## 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]/ragic_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EmailDetected project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ragic_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ragic_client"
+
+# 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/ragic_client.rb

@@ -0,0 +1,130 @@
+require 'ragic_client/version'
+require 'httparty'
+require 'json'
+
+module RagicClient
+  class Error < StandardError; end
+  module Config
+    class << self
+      attr_accessor :ragic_api_url
+      attr_accessor :ragic_api_key
+
+      def setup
+        @ragic_api_url = ragic_api_url
+        @ragic_api_key = ragic_api_key
+      end
+    end
+    self.setup
+  end
+
+  def self.config(&block)
+    if block_given?
+      block.call(RagicClient::Config)
+    else
+      RagicClient::Config
+    end
+  end
+
+  def self.ragic_base_api_url(ragic_id = nil)
+    return "#{RagicClient::Config.ragic_api_url}/#{ragic_id}" if ragic_id
+
+    RagicClient::Config.ragic_api_url
+  end
+
+  def self.headers
+    {
+      'Content-Type': 'application/json',
+      'Authorization': RagicClient::Config.ragic_api_key
+    }
+  end
+
+  def self.find(ragic_id)
+    opts = {
+      headers: RagicClient.headers
+    }
+    beauty_body HTTParty.get(ragic_base_api_url(ragic_id), opts), ragic_id: ragic_id
+  end
+
+  # https://www.ragic.com/intl/en/doc-api/9/Filter-Conditions
+  def self.find_by(condition_hash = {})
+    opts = {
+      headers: RagicClient.headers
+    }
+    api_url = [ragic_base_api_url]
+    return {
+      status: false,
+      msg: 'Invalid conditions params'
+    } unless condition_hash.is_a?(Hash)
+    index = 0
+    condition_hash.each do |key, value|
+      api_url.push("#{index.zero? ? '?' : '&'}where=#{key},eq,#{value}")
+      index += 1
+    end
+    api_url = api_url.join('')
+    beauty_body HTTParty.get(api_url, opts)
+  end
+
+  # https://www.ragic.com/intl/en/doc-api/20/Deleting-an-entry
+  def self.delete(ragic_id)
+    opts = {
+      headers: RagicClient.headers
+    }
+    beauty_body HTTParty.delete(ragic_base_api_url(ragic_id), opts)
+  end
+
+  # https://www.ragic.com/intl/en/doc-api/15/Creating-a-New-Entry
+  def self.create(params = {})
+    ragic_params = { doDefaultValue: true, doLinkLoad: true }
+    ragic_params = ragic_params.merge!(params)
+    opts = {
+      headers: RagicClient.headers,
+      body: ragic_params.to_json
+    }
+    beauty_body HTTParty.post(ragic_base_api_url, opts)
+  end
+
+  # https://www.ragic.com/intl/en/doc-api/16/Modifying-an-Entry
+  def self.update(ragic_id, params = {})
+    opts = {
+      headers: RagicClient.headers,
+      body: params.to_json
+    }
+    beauty_body HTTParty.post(ragic_base_api_url(ragic_id), opts), is_update: true
+  end
+
+  def self.beauty_body(response, options = {})
+    success = false
+    status_code = response.code
+    if status_code == 200
+      begin
+        body = JSON.parse(response.body) || {}
+        data =
+          if options[:is_update]
+            body['data']
+          elsif options[:ragic_id]
+            body[options[:ragic_id].to_s]
+          else
+            body
+          end
+        success = true if body['status'] != 'ERROR'
+        msg = 'Ragic ID Not Found.' if ragic_id
+        msg = body['msg']&.gsub('&nbsp;', '') if data
+      rescue
+        msg = 'Error!'
+      end
+    else
+      begin
+        body = JSON.parse(response.body)
+        msg = body['msg']&.gsub('&nbsp;', '')
+      rescue
+        msg = 'Error!'
+      end
+    end
+    {
+      status_code: status_code,
+      success: success,
+      data: data,
+      msg: msg
+    }.delete_if { |_k, v| v.nil? }
+  end
+end

data/lib/ragic_client/version.rb

@@ -0,0 +1,3 @@
+module RagicClient
+  VERSION = "0.1.3"
+end

data/ragic_client.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/ragic_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ragic_client"
+  spec.version       = RagicClient::VERSION
+  spec.authors       = ["Derek Nguyen"]
+  spec.email         = ["derek.nguyen.269@gmail.com"]
+
+  spec.summary       = 'RagicClient'
+  spec.description   = 'RagicClient is a simple tool integrate with RAGIC system.'
+  spec.homepage      = "https://github.com/dereknguyen269/ragic_client"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dereknguyen269/ragic_client"
+  spec.metadata["changelog_uri"] = "https://github.com/dereknguyen269/ragic_client/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"]
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ragic_client
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Derek Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-31 00:00:00.000000000 Z
+dependencies: []
+description: RagicClient is a simple tool integrate with RAGIC system.
+email:
+- derek.nguyen.269@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ragic_client.rb
+- lib/ragic_client/version.rb
+- ragic_client.gemspec
+homepage: https://github.com/dereknguyen269/ragic_client
+licenses: []
+metadata:
+  homepage_uri: https://github.com/dereknguyen269/ragic_client
+  source_code_uri: https://github.com/dereknguyen269/ragic_client
+  changelog_uri: https://github.com/dereknguyen269/ragic_client/CHANGELOG.md
+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: RagicClient
+test_files: []