countonce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85bf33fb4d07145b50872e1c42e5f1cb2ef88c7730e783c6aa11fe6c17d36b68
+  data.tar.gz: feaaf06258daa3ca090ad58e781be320428c6e41aa312a3ba6df11c78b40778a
+SHA512:
+  metadata.gz: 6a8d2ea49999cae75a31bf4327194175133e656086f386eeb3ce692c3fc2dafab998f2d85ccb41f19e300c8db9f13df608fee6fe31a2191a817e6474ab2ea156
+  data.tar.gz: 033fa55deb979134dda4e15f0df61b396a9d52c5d429cc8ef22d8f6988b3218e0fa005068c0d72265125b5db9498dc9a1a7ea3414b19eefc330cbcbff93a5366

data/.gitignore

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

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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in countonce.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,129 @@
+# CountOnce-ruby
+
+Wrapper for the CountOnce API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'countonce'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install countonce
+
+## Usage
+
+### Ping
+```ruby
+require "countonce"
+
+co_client = CountOnce.new({
+  account_id: "<account_id>",
+  auth_token: "<your api auth token>"
+})
+
+begin
+
+  response = co_client.ping({
+    key: "<key>",
+    attributes: {
+      account_id: "<attribute value>",
+      action: "<attribute value>"
+    },
+    unique_value: "<unique id or hash>",
+    revenue: 0.00
+  })
+  puts response.json
+
+rescue StandardError => e
+  puts e.message
+
+end
+```
+
+>The '.then' function only works on Windows for now. Hence, the following example is Windows only.
+
+```ruby
+require "countonce"
+
+co_client = CountOnce.new({
+  account_id: "<account_id>",
+  auth_token: "<your api auth token>"
+})
+
+begin
+
+  co_client.async.ping({
+    key: "<key>",
+    attributes: {
+      account_id: "<attribute value>",
+      action: "<attribute value>"
+    },
+    unique_value: "<unique id or hash>",
+    revenue: 0.00
+  }).then {|response| puts response.value.json}
+
+rescue StandardError => e
+  puts e.message
+
+end
+```
+
+### Query
+```ruby
+require "countonce"
+
+co_client = CountOnce.new({
+  account_id: "<account_id>", 
+  auth_token: "<your api auth token>"
+})
+
+query_options = {
+  metric: "daily"
+}
+
+begin
+
+  data = co_client.getUniques("<key>", query_options)
+  p data.json
+
+rescue StandardError => e
+  puts e.message
+
+end
+```
+
+>Same case as for the ping example. You can use the ```then``` function but only with Windows.
+
+```ruby
+require "countonce"
+
+co_client = CountOnce.new({
+  account_id: "<account_id>", 
+  auth_token: "<your api auth token>"
+})
+
+query_options = {
+  metric: "daily"
+}
+
+begin
+
+  co_client.async.getUniques("<key>", query_options).then {|data|
+    p data.value.json
+  }
+
+rescue StandardError => e
+  puts e.message
+
+end
+```
+
+For more information on async, please refer to the concurrent-ruby's documentation.

data/bin/console

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

@@ -0,0 +1,29 @@
+require_relative 'lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "countonce"
+  spec.version       = CountOnce::VERSION
+  spec.authors       = ["CountOnce"]
+  spec.email         = ["info@countonce.com"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{Wrapper for the CountOnce API}
+  spec.homepage      = "https://www.countonce.com"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/countonce/countonce-ruby"
+
+  # 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.require_paths = ["lib"]
+
+  # dependencies
+  spec.add_dependency "httparty", "~> 0.18.0"
+  spec.add_dependency "concurrent-ruby", "~> 1.1.6"
+end

data/lib/countonce.rb

@@ -0,0 +1,104 @@
+require "httparty"
+require "concurrent-ruby"
+
+PingResult = Struct.new(:json)
+QueryResult = Struct.new(:json)
+
+class CountOnce
+  include Concurrent::Async
+
+  DEFAULT_DOMAIN = "countapi.com"
+  DEFAULT_SCHEMA = "https"
+
+  attr_accessor :account_id
+  attr_accessor :auth_token
+  attr_accessor :url
+
+  def initialize(credentials = {})
+    @account_id = credentials[:account_id]
+    @auth_token = credentials[:auth_token]
+
+    api_protocol = ENV.key?("_API_PROTOCOL") ? ENV["_API_PROTOCOL"] : DEFAULT_SCHEMA
+    api_domain = ENV.key?("_API_DOMAIN") ? ENV["_API_DOMAIN"] : DEFAULT_DOMAIN
+    
+    @url = "#{api_protocol}://#{credentials[:account_id]}.#{api_domain}"
+  end
+
+  def ping(ping_options = {})
+    url_params = {}
+    url_params["key"] = ping_options[:key] || ""
+    url_params["unique_value"] = ping_options[:unique_value] || ""
+    
+    headers = {}
+    headers["Content-Type"] = "application/x-www-form-urlencoded; charset=UTF-8" 
+    headers["Authorization"] = "Bearer #{@auth_token}" if @auth_token
+  
+    if ping_options[:attributes]
+      ping_options[:attributes].each {|key, value| url_params["attributes[#{key}]"] = value}
+    end
+
+    url_params["revenue"] = ping_options[:revenue] if ping_options[:revenue]
+    url_params["timezone"] = ping_options[:timezone] if ping_options[:timezone]
+
+    response = HTTParty.post(
+      @url + "/ping",
+      :body => url_params,
+      :headers => headers,
+      :verify => false
+    )
+
+    PingResult.new(response.parsed_response)
+  end
+
+  def query(key_name, query_type, query_options = {}, iterator = nil)
+    url_params = {}
+    url_params["iterator"] = iterator if iterator
+
+    headers = {}
+    headers["Authorization"] = "Bearer #{@auth_token}" if @auth_token
+
+    if query_options[:filter]
+      query_options[:filter].each {|key, value| url_params["filter[#{key}]"] = value}
+    end
+
+    if query_options[:include]
+      if query_options[:include].is_a? Array
+        query_options[:include] = query_options[:include].join(",")
+      end
+      
+      url_params["include"] = query_options[:include]
+    end
+
+    url_params["start_date"] = query_options[:start_date] if query_options[:start_date]
+    url_params["end_date"] = query_options[:start_date] if query_options[:end_date]
+    url_params["range"] = query_options[:start_date] if query_options[:range]
+    url_params["prev_start_date"] = query_options[:start_date] if query_options[:prev_start_date]
+    url_params["prev_end_date"] = query_options[:start_date] if query_options[:prev_end_date]
+    url_params["prev_range"] = query_options[:start_date] if query_options[:prev_date]
+
+    response = HTTParty.get(
+      "#{@url}/#{query_type}/#{key_name}/#{query_options[:metric] || 'daily'}",
+      :query => url_params,
+      :headers => headers,
+      :verify => false
+    )
+
+    return QueryResult.new(response.parsed_response)
+  end
+
+  def getUniques(key_name, query_options = {}, iterator = nil)
+    self.query(key_name, 'uniques', query_options, iterator)
+  end
+
+  def getIncrements(key_name, query_options = {}, iterator = nil)
+    self.query(key_name, 'increments', query_options, iterator)
+  end
+
+  def getRevenue(key_name, query_options = {}, iterator = nil)
+    self.query(key_name, 'revenue', query_options, iterator)
+  end
+
+  def getCombined(key_name, query_options = {}, iterator = nil)
+    self.query(key_name, 'combined', query_options, iterator)
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+class CountOnce
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: countonce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CountOnce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+description: 
+email:
+- info@countonce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- countonce.gemspec
+- lib/countonce.rb
+- lib/version.rb
+homepage: https://www.countonce.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.countonce.com
+  source_code_uri: https://github.com/countonce/countonce-ruby
+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.4
+signing_key: 
+specification_version: 4
+summary: Wrapper for the CountOnce API
+test_files: []