simple_analytics_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7a2363c648b5d9e7701ed484a8c5672571061099ff6c1c5763dae0049226493
+  data.tar.gz: c54fd3de26899bdf1c94fdb8f1cea8e9fb479de3ceddd3ee938634bbb08533b6
+SHA512:
+  metadata.gz: a2e722f773e5fe8fa23d8277d9bbbf80413ad8e79bc8ea6b1b04dfb96526918862d473374dd0abe2813f3a5d3b1d3476c98ed3c54e323870a9d6417cada20a3b
+  data.tar.gz: ecb85271ac70fc4089a4fca80462476fd06202157d77e724c404a4fd423220096621ffa98d93fe27c1561ddf89e9be84fc9980c05be0863c157de7bdf7a03315

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at luctus@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    simple_analytics_api (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.3)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  simple_analytics_api!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Gustavo Garcia
+
+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,50 @@
+# Simple Analytics API Ruby Gem
+This is a simple wrapper to read the Simple Analytics API with Ruby.
+It's based on the [API guide](https://docs.simpleanalytics.com/api/stats)
+
+## Usage
+Add this gem to your Gemfile:
+
+```rb
+gem 'simple_analytics_api'
+```
+
+Now you need to initialize a Client with your `api_key` (if the domain is not public), the `user_id` (required for some specific actions), and the `domain` you want to get stats from.
+
+```rb
+client = SimpleAnalyticsApi::Client.new(api_key: '<api_key>', user_id: '<user_id>', domain: '<domain>') 
+
+# Test if the credentials are valid (all public domains should return true)
+client.valid?
+=> true
+```
+
+To get some actual data, you can use the `run` method, like this:
+```rb
+client.run(
+  fields: %w(pageviews visitors pages), 
+  filters: {
+    start: '2021-01-01 00:00', 
+    end: '2021-01-31 23:59'
+  }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/dailytics/simpleanalytics_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dailytics/simpleanalytics_api/blob/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleAnalyticsApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dailytics/simpleanalytics_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SimpleAnalyticsApi
+  class Client
+
+    attr_accessor :api_key, :user_id, :domain
+
+    def initialize(api_key: nil, user_id: nil, domain:)
+      @api_key = api_key.to_s
+      @user_id = user_id.to_s
+      @domain  = domain.to_s
+    end
+
+    def valid?
+      run.ok rescue false
+    end
+
+    def run(fields: [], filters: {})
+      Resource.new(client: self, fields: fields, filters: filters).run
+    end
+  end
+end

data/lib/simple_analytics_api/error.rb

@@ -0,0 +1,4 @@
+module SimpleAnalyticsApi
+  class Error < StandardError
+  end
+end

data/lib/simple_analytics_api/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module SimpleAnalyticsApi
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/simple_analytics_api/resource.rb

@@ -0,0 +1,52 @@
+module SimpleAnalyticsApi
+  class Resource
+
+    BASE_URL = 'https://simpleanalytics.com'
+
+    attr_accessor :client, :fields, :filters, :domain
+
+    def initialize(client:, domain: nil, fields: [], filters: {})
+      @client  = client
+      @fields  = fields
+      @filters = filters
+      @domain  = domain || client.domain
+      @errors  = []
+      @filters[:version] = 5 unless @filters[:version]
+      @fields = [:pageviews] unless @fields.any?
+    end
+
+    def fields_and_filters
+      fields_and_filters = filters
+      fields_and_filters = filters.merge({ fields: fields.join(',') }) if fields.any?
+      
+      fields_and_filters.sort_by{|k,v| k}.to_h
+    end
+
+    def parse_response(body)
+      Object.new JSON.parse(body)
+    end
+
+    def url
+      url = "#{BASE_URL}/#{domain}.json"
+      url << "?#{fields_and_filters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&") }" if fields_and_filters.any?
+      url
+    end
+
+    def run
+      uri = URI.parse url
+      req = Net::HTTP::Get.new(uri.request_uri)
+      req.add_field('Content-Type', 'application/json')
+      req.add_field('Api-Key', client.api_key) unless client.api_key.empty?  
+      req.add_field('User-Id', client.user_id) unless client.user_id.empty?
+    
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true  
+      
+      response = http.request(req)
+      raise SimpleAnalyticsApi::Error.new "Api request failed (#{response.body})" unless response.code == "200"
+      raise SimpleAnalyticsApi::Error.new "Api request returned nil (#{response.body})" if response.body.nil?
+
+      parse_response response.body
+    end
+  end
+end

data/lib/simple_analytics_api/version.rb

@@ -0,0 +1,3 @@
+module SimpleAnalyticsApi
+  VERSION = "0.0.1"
+end

data/lib/simple_analytics_api.rb

@@ -0,0 +1,14 @@
+require 'json'
+require "net/http"
+require "uri"
+require "cgi"
+
+require 'simple_analytics_api/version'
+
+module SimpleAnalyticsApi
+  autoload :Client, "simple_analytics_api/client"
+  autoload :Error, "simple_analytics_api/error"
+
+  autoload :Resource, "simple_analytics_api/resource"
+  autoload :Object, "simple_analytics_api/object"
+end

data/simple_analytics_api.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/simple_analytics_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_analytics_api"
+  spec.version       = SimpleAnalyticsApi::VERSION
+  spec.authors       = ["Gustavo Garcia"]
+  spec.email         = ["gustavo@dailytics.com"]
+
+  spec.summary       = 'A simple simpleanalytics Analytics API wrapper for Rails'
+  spec.description   = 'A very humble wrapper for the API by simpleanalytics.io'
+  spec.homepage      = "https://github.com/dailytics/simpleanalytics_api"
+  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/dailytics/simpleanalytics_api"
+  spec.metadata["changelog_uri"] = "https://github.com/dailytics/simpleanalytics_api"
+
+  # 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,62 @@
+--- !ruby/object:Gem::Specification
+name: simple_analytics_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Garcia
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-16 00:00:00.000000000 Z
+dependencies: []
+description: A very humble wrapper for the API by simpleanalytics.io
+email:
+- gustavo@dailytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_analytics_api.rb
+- lib/simple_analytics_api/client.rb
+- lib/simple_analytics_api/error.rb
+- lib/simple_analytics_api/object.rb
+- lib/simple_analytics_api/resource.rb
+- lib/simple_analytics_api/version.rb
+- simple_analytics_api.gemspec
+homepage: https://github.com/dailytics/simpleanalytics_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dailytics/simpleanalytics_api
+  source_code_uri: https://github.com/dailytics/simpleanalytics_api
+  changelog_uri: https://github.com/dailytics/simpleanalytics_api
+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: A simple simpleanalytics Analytics API wrapper for Rails
+test_files: []