malartu 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1de880b32bdae8cec4dfe3160b1632e633153be7
+  data.tar.gz: 99335adf08e0d7affbd7beffddc3df038fca30eb
+SHA512:
+  metadata.gz: ccc1f2d3a01e5a718e11c2b1dde752daa600627e866cf60da8bb0c8b2818a6f0430f6ef0b33071827504a3f8469a93fc93dbe25454934bf28e6c9c7df1ec90e0
+  data.tar.gz: 16cff108e55cf328b465a12da36fcad49762cf2137f09dacb7c6e20b112f4619c7ae9d12d9b732eae11d2baff3f08ed011fb6ad2d0c8d07bdd38a8778ce039e5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in malartu.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 david-richey
+
+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,51 @@
+# Malartu
+
+Malartu API makes it easy to interact with [Malartu](https://www.malartu.co/). This gem is a ruby wrapper for the [Malartu API](https://app.malartu.co/docs/api).
+
+Some examples of what you can do with the Malartu API:
+
+* Track custom metrics to be aggregated into your other integrations data. See what [integration Malartu provides](https://www.malartu.co/integrations/)
+* View your aggregated metrics
+* View your reports created in Malartu
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'malartu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install malartu
+
+## Usage
+
+Set your apikey
+`Malartu.apikey = 'XXXXX-XXXXXXXXXXXXXXX'`
+
+Start extending your usage with the Malartu API
+```
+Malartu::Metric.uids # valid uids you are tracking in Malartu
+Malartu::Metric.list(starting: (Date.today - 5.days).to_s, ending: Date.today.to_s, uids: ['arr', 'mrr'])
+Malartu::Tracking::Data.list(starting: (Date.today - 5.days).to_s, ending: Date.today.to_s)
+Malartu::Schedule.list
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davidrichey/malartu-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).

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 "malartu"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/malartu.rb

@@ -0,0 +1,81 @@
+require 'http'
+
+require 'malartu/malartu_object'
+require 'malartu/connection'
+require 'malartu/error'
+require 'malartu/metric'
+require 'malartu/portfolio'
+require 'malartu/schedule'
+require 'malartu/tracking'
+require 'malartu/tracking/data'
+require 'malartu/version'
+
+module Malartu
+  API_VERSION = 'v0'.freeze
+  API_PATH = 'https://api.malartu.co'.freeze
+  class << self
+    attr_accessor :apikey, :api_version, :topics
+
+    def request(method, path, params = {}, _headers = {})
+      url = "#{base_path}#{path}"
+      req_params = case method.to_s
+                   when 'get'
+                     { params: params.merge(auth_params) }
+                   else
+                     { json: params.merge(auth_params) }
+                   end
+      response = HTTP.send(method, url, req_params)
+      check_for_errors(response, params.merge(auth_params))
+      JSON.parse(response.body)
+    end
+
+    def auth_params
+      fail 'No apikey present. Set it with `Malartu.apikey =`' if apikey.nil?
+      { apikey: apikey }
+    end
+
+    def base_path
+      "#{API_PATH}/#{version}"
+    end
+
+    def version
+      api_version || API_VERSION
+    end
+
+    def check_for_errors(response, params)
+      case response.code
+      when 401
+        fail Malartu::Error::AuthorizationError.new(
+          message: 'Credentials do not match',
+          parameters: {
+            apikey: params[:apikey]
+          },
+          json_body: JSON.parse(response.body)
+        )
+      when 404
+        fail Malartu::Error::RecordNotFoundError.new(
+          message: 'Record Not Found',
+          parameters: {
+            id: params[:id],
+            model: params[:model]
+          },
+          json_body: JSON.parse(response.body)
+        )
+      when 429
+        fail Malartu::Error::RateLimitError.new(
+          message: 'Rate Limited',
+          parameters: {
+            apikey: params[:apikey]
+          },
+          json_body: JSON.parse(response.body)
+        )
+      when 500
+        fail Malartu::Error::ServerError.new(
+          message: 'Server Error',
+          parameters: params,
+          json_body: JSON.parse(response.body)
+        )
+      end
+    end
+  end
+end

data/lib/malartu/connection.rb

@@ -0,0 +1,23 @@
+module Malartu
+  # A connection is what ties together a company and a portfolios
+  class Connection < MalartuObject
+    def self.list
+      res = Malartu.request('get', '/kpi/connections')
+      res['connections'].map do |connection|
+        Malartu::Schedule.new(connection)
+      end
+    end
+
+    def self.metrics(id, starting: nil, ending: DateTime.now.to_s, grain: nil, timezone: "UTC", uids: [])
+      uids = uids.join(',')
+      params = {
+        start_date: starting,
+        end_date: ending,
+        grain: grain,
+        timezone: timezone,
+        uids: uids
+      }.select { |_, value| !value.nil? }
+      Malartu.request('get', "/kpi/connections/#{1}/metrics", params)
+    end
+  end
+end

data/lib/malartu/error.rb

@@ -0,0 +1,25 @@
+module Malartu
+  module Error
+    class MalartuError < StandardError
+      attr_reader :message, :parameters, :json_reponse
+
+      def initialize(message: nil, parameters: nil, json_body: nil)
+        @message = message
+        @parameters = parameters
+        @json_body = json_body
+      end
+    end
+
+    class AuthorizationError < MalartuError
+    end
+
+    class RateLimitError < MalartuError
+    end
+
+    class RecordNotFoundError < MalartuError
+    end
+
+    class ServerError < MalartuError
+    end
+  end
+end

data/lib/malartu/malartu_object.rb

@@ -0,0 +1,19 @@
+module Malartu
+  class MalartuObject
+    attr_accessor :json
+    def initialize(json)
+      json.each do |k, v|
+        define_singleton_method(k) { v }
+      end
+      @json = json
+    end
+
+    def self.paginate?(response)
+      page = response['page'].to_i
+      limit = response['limit'].to_i
+      found = response['found'].to_i
+      count = response['count'].to_i
+      ((page - 1) * limit) + count < found
+    end
+  end
+end

data/lib/malartu/metric.rb

@@ -0,0 +1,20 @@
+module Malartu
+  # Metrics is how Malartu tracks data from various sources
+  class Metric < MalartuObject
+    def self.uids
+      Malartu.request('get', '/kpi/metric/uids')['valid_metric_uids']
+    end
+
+    def self.list(starting: nil, ending: Date.today.to_s, grain: nil, timezone: 'UTC', uids: [])
+      uids = uids.join(',')
+      params = {
+        start_date: starting,
+        end_date: ending,
+        grain: grain,
+        timezone: timezone,
+        uids: uids
+      }.select { |_, value| !value.nil? }
+      Malartu.request('get', '/kpi/metrics', params)
+    end
+  end
+end

data/lib/malartu/portfolio.rb

@@ -0,0 +1,27 @@
+module Malartu
+  # A portfolio is how groups track companies within Malartu
+  class Portfolio < MalartuObject
+    attr_accessor :connections, :path
+    def initialize(json)
+      super
+      define_singleton_method('connections') do
+        json['connections'].map do |c|
+          Malartu::Connection.new(c)
+        end
+      end if json['connections']
+      define_singleton_method('path') { json['path'] || "/v0/kpi/portfolios/#{sid}" }
+    end
+
+    def self.find(sid)
+      res = Malartu.request('get', "/kpi/portfolios/#{sid}")
+      Malartu::Portfolio.new(res)
+    end
+
+    def self.list
+      res = Malartu.request('get', '/kpi/portfolios')
+      res['portfolios'].map do |schedule|
+        Malartu::Portfolio.new(schedule)
+      end
+    end
+  end
+end

data/lib/malartu/schedule.rb

@@ -0,0 +1,24 @@
+module Malartu
+  # A schedule is what tells Malartu when to aggregate the data
+  class Schedule < MalartuObject
+    def self.find(id = 'api')
+      res = Malartu.request('get', "/kpi/schedules/#{id}")
+      Malartu::Schedule.new(res)
+    end
+
+    def self.list
+      res = Malartu.request('get', '/kpi/schedules')
+      res['schedules'].map do |schedule|
+        Malartu::Schedule.new(schedule)
+      end
+    end
+
+    def self.update(id = 'api', active: false)
+      fail 'Invalid ID' unless id == 'api'
+      params = {}
+      params[:active] = active unless active.nil?
+      res = Malartu.request('patch', "/kpi/schedules/#{id}", params)
+      Malartu::Schedule.new(res)
+    end
+  end
+end

data/lib/malartu/tracking.rb

@@ -0,0 +1,4 @@
+module Malartu
+  module Tracking
+  end
+end

data/lib/malartu/tracking/data.rb

@@ -0,0 +1,43 @@
+module Malartu
+  module Tracking
+    # Tracking::Data lets you store data is the Malartu system
+    class Data < MalartuObject
+      def self.create(topic: nil, value: 1)
+        fail 'No topic' if topic.nil?
+        res = Malartu.request('post', '/kpi/tracking/data', topic: topic, value: value)
+        Malartu::Tracking::Data.new(res)
+      end
+
+      def self.find(id)
+        fail 'No ID given' if id.nil?
+        path = "/kpi/tracking/data/#{id}"
+        res = Malartu.request('get', path)
+        Malartu::Tracking::Data.new(res)
+      end
+
+      def self.list(starting:, ending:, page: 1, paginate: false, topic: nil)
+        params = { starting: starting, ending: ending, topic: topic, page: page }.select { |_, value| !value.nil? }
+        res = Malartu.request('get', '/kpi/tracking/data', params)
+        data = res['data'].map do |datum|
+          Malartu::Tracking::Data.new(datum)
+        end
+        page = res["page"].to_i
+        return data unless paginate?(res)
+        # Paginated requests
+        res = Malartu.request('get', '/kpi/tracking/data', params.merge(page: page + 1))
+        data + res['data']
+      end
+
+      def self.update(id, topic: nil, value: 1)
+        fail 'No Topic' if topic.nil?
+        params = {}
+        params[:topic] = topic unless topic.nil?
+        params[:value] = value unless value.nil?
+        fail 'No parameters to send' if params == {}
+        path = "/kpi/tracking/data/#{id}"
+        res = Malartu.request('patch', path, params)
+        Malartu::Tracking::Data.new(res)
+      end
+    end
+  end
+end

data/lib/malartu/version.rb

@@ -0,0 +1,3 @@
+module Malartu
+  VERSION = '0.1.3'.freeze
+end

data/malartu.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'malartu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'malartu'
+  spec.version       = Malartu::VERSION
+  spec.authors       = ['david-richey']
+  spec.email         = ['david.richey@validic.com']
+
+  spec.summary       = %q{Wrapper for Malartu API}
+  spec.description   = %q{Ruby Wrapper for Malartu API}
+  spec.homepage      = 'https://app.malartu.co/docs/api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_dependency 'http', '~> 3.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: malartu
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- david-richey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby Wrapper for Malartu API
+email:
+- david.richey@validic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/malartu.rb
+- lib/malartu/connection.rb
+- lib/malartu/error.rb
+- lib/malartu/malartu_object.rb
+- lib/malartu/metric.rb
+- lib/malartu/portfolio.rb
+- lib/malartu/schedule.rb
+- lib/malartu/tracking.rb
+- lib/malartu/tracking/data.rb
+- lib/malartu/version.rb
+- malartu.gemspec
+homepage: https://app.malartu.co/docs/api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Wrapper for Malartu API
+test_files: []