chart_mogul 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dacc8e1ab7ea648768a32a8e3cd7a0940d08ba83
+  data.tar.gz: d3591d6e6a8dea310da2f3d7b19244e44cd7fedf
+SHA512:
+  metadata.gz: 06209d073ba8e80b49191659e818078fdf5663992e31e986398245e4313e35f3cefeb67662028f4a5bac25e60b745a6da8555f3f2f4808140fb68a8610214082
+  data.tar.gz: f8dea0e870b94b7fe4c60883418aad0a3ff6b54659b0a01145811b94fa380fda7761e20ff2d9073299ad95f261bf9ad800bbc24c56cdb8a0ed39f7211c2e1c9c

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chart_mogul.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam Bird
+
+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,41 @@
+# ChartMogul
+
+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/chart_mogul`. 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 'chart_mogul'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chart_mogul
+
+## 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]/chart_mogul. 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 "chart_mogul"
+
+# 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/chart_mogul.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chart_mogul/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chart_mogul"
+  spec.version       = ChartMogul::VERSION
+  spec.authors       = ["Adam Bird"]
+  spec.email         = ["adam.bird@gmail.com"]
+
+  spec.summary       = %q{Gem for working with the ChartMogul API}
+  spec.homepage      = "https://github.com/adambird/chart-mogul-ruby"
+  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_runtime_dependency "faraday", "~> 0.9"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/lib/chart_mogul/assertive.rb

@@ -0,0 +1,30 @@
+module ChartMogul
+  module Assertive
+    def self.included(base)
+      base.extend(Assertive)
+    end
+
+    private
+
+    def assert!(predicate, message)
+      return if predicate
+
+      fail ArgumentError, message
+    end
+
+    def assert_fetch!(hash, key, message = nil)
+      hash.fetch(key) do
+        message = "#{key} must be defined" unless message
+        fail ArgumentError, message
+      end
+    end
+
+    def refute!(predicate, message)
+      assert! !predicate, message
+    end
+
+    def refute_blank!(value, attribute_name)
+      assert! (!value.nil? && value != ""), "#{attribute_name} cannot be nil or blank"
+    end
+  end
+end

data/lib/chart_mogul/client.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+require 'json'
+
+module ChartMogul
+  # Public: Primary class for interacting with the ChartMogul API.
+  class Client
+    include ImportApi
+
+    API_ROOT_URL = "https://api.chartmogul.com"
+
+    attr_reader :account_token
+    attr_reader :secret_key
+
+    # Public: Initialize a new ChartMogul::Client.
+    #
+    # options - A Hash of options used to initialize the client (default: {}):
+    #           :account_token - The Account Token assigned to your account
+    #                            (default: ENV["CHART_MOGUL_ACCOUNT_TOKEN"]).
+    #           :secret_key    - The Secret key assigned to your account
+    #                            (default: ENV["CHART_MOGUL_SECRET_KEY"]).
+    def initialize(options={})
+      @account_token = options.fetch(:account_token, ENV["CHART_MOGUL_ACCOUNT_TOKEN"])
+      @secret_key    = options.fetch(:secret_key, ENV["CHART_MOGUL_SECRET_KEY"])
+    end
+
+    def connection
+      @connection ||= Faraday.new(API_ROOT_URL) do |builder|
+                        builder.basic_auth(account_token, secret_key)
+                        builder.adapter Faraday.default_adapter
+                      end
+    end
+
+    def ping?
+      response = connection.get("/v1/ping")
+      preprocess_response(response)[:data] == 'pong!'
+    end
+
+    def paged_get(path, params, data_field)
+      begin
+        result = preprocess_response(connection.get(path, params))
+        yield result[data_field]
+        params[:page_number] = result[:current_page]
+      end while params[:page_number] < result[:total_pages]
+    end
+
+    def preprocess_response(response)
+      case response.status
+      when 200..299
+        JSON.parse(response.body, symbolize_names: true)
+      when 401
+        raise UnauthorizedError.new
+      when 422
+        result = JSON.parse(response.body, symbolize_names: true)
+        raise ValidationError.new(result[:errors])
+      else
+        puts response.inspect
+        raise StandardError.new("#{response.status} #{response.body.slice(0,50)}")
+      end
+    end
+
+    class UnauthorizedError < StandardError
+    end
+
+    class ValidationError < StandardError
+
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+        super("validation errors for #{errors.keys.join(', ')}")
+      end
+
+    end
+  end
+end

data/lib/chart_mogul/import/customer.rb

@@ -0,0 +1,25 @@
+module ChartMogul
+  module Import
+    class Customer
+
+      attr_reader :uuid
+      attr_reader :data_source_uuid
+      attr_reader :external_id
+
+      attr_reader :name
+      attr_reader :company
+      attr_reader :email
+      attr_reader :city
+      attr_reader :state
+      attr_reader :country
+      attr_reader :zip
+
+      def initialize(args)
+        args.each_pair do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+    end
+  end
+end

data/lib/chart_mogul/import/data_source.rb

@@ -0,0 +1,19 @@
+module ChartMogul
+  module Import
+    class DataSource
+
+      attr_reader :created_at
+      attr_reader :name
+      attr_reader :status
+      attr_reader :uuid
+
+      def initialize(args)
+        @name = args[:name]
+        @status = args[:status]
+        @uuid = args[:uuid]
+        @created_at = Time.parse(args[:created_at]) if args[:created_at]
+      end
+
+    end
+  end
+end

data/lib/chart_mogul/import/plan.rb

@@ -0,0 +1,20 @@
+module ChartMogul
+  module Import
+    class Plan
+
+      attr_reader :uuid
+      attr_reader :data_source_uuid
+      attr_reader :name
+      attr_reader :interval_count
+      attr_reader :interval_unit
+
+      attr_reader :external_id
+
+      def initialize(args)
+        args.each_pair do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+  end
+end

data/lib/chart_mogul/import_api.rb

@@ -0,0 +1,162 @@
+require_relative 'import/customer'
+require_relative 'import/data_source'
+require_relative 'import/plan'
+
+module ChartMogul
+  module ImportApi
+    include Assertive
+
+    # Public - list DataSources
+    #
+    # Returns an Array of ChartMogul::Import::DataSource
+    def list_data_sources
+      response = connection.get("/v1/import/data_sources")
+      preprocess_response(response)[:data_sources]
+        .map { |ds| Import::DataSource.new(ds) }
+    end
+
+    # Public - create a DataSource
+    #
+    # args   - Hash of params only :name is supported
+    #          {
+    #            name: "Name of data source"
+    #          }
+    #
+    # Returns a ChartMogul::Import::DataSource
+    def create_data_source(args)
+      refute_blank! args[:name], :name
+
+      response = connection.post do |request|
+        request.url "/v1/import/data_sources"
+        request.headers['Content-Type'] = "application/json"
+        request.body = args.to_json
+      end
+
+      Import::DataSource.new(preprocess_response(response))
+    end
+
+    # Public - purge all data for a DataSource
+    #          super dangerous
+    #
+    # Returns nothing but an empty hole where your data was!
+    def purge_data_source!(data_source_uuid)
+      response = connection.delete do |request|
+        request.url "/v1/import/data_sources/#{data_source_uuid}/erase_data"
+        request.headers['Content-Type'] = "application/json"
+        request.body = { confirm: 1 }.to_json
+      end
+      response.status == 202
+    end
+
+    # Public - list all Customers.
+    #          this will page through all customers see #list_customers_each
+    #          for iterator method to prevent loading the whole array in
+    #          memory
+    #
+    # options - see #list_customers_each
+    #
+    # Returns an Array of ChartMogul::Import::Customer
+    def list_customers(options={})
+      customers = []
+      list_customers_each(options) { |c| customers << c }
+      customers
+    end
+
+    # Public    - iterate through all customers
+    #
+    # options   - Hash of filter options
+    #             :data_source_uuid
+    #
+    # Returns an Enumerable that will yield a ChartMogul::Import::Customer for
+    # each record
+    def list_customers_each(options={}, &block)
+      params = { page_number: 1 }
+      params[:data_source_uuid] = options[:data_source_uuid] if options[:data_source_uuid]
+
+      paged_get("/v1/import/customers", params, :customers) do |customers|
+        customers.each do |customer|
+          yield Import::Customer.new(customer)
+        end
+      end
+    end
+
+    # Public - create a Customer
+    #
+    # args   - Hash of params see https://dev.chartmogul.com/docs/customers
+    #          Mandatory: :data_source_uuid, :external_id, :name
+    #
+    # Returns a ChartMogul::Import::Customer
+    def create_customer(args)
+      [:data_source_uuid, :external_id, :name].each do |attribute|
+        refute_blank! args[attribute], attribute
+      end
+
+      # ChartMogul API will 500 if nill keys are sent
+      args.keys.each do |key|
+        refute! args[key].nil?, "nil keys not supported [#{key}]"
+      end
+
+      response = connection.post do |request|
+        request.url "/v1/import/customers"
+        request.headers['Content-Type'] = "application/json"
+        request.body = args.to_json
+      end
+
+      Import::Customer.new(preprocess_response(response))
+    end
+
+    # Public - list all Plans.
+    #          this will page through all plans see #list_plans_each
+    #          for iterator method to prevent loading the whole array in
+    #          memory
+    #
+    # options - see #list_plans_each
+    #
+    # Returns an Array of ChartMogul::Import::Plan
+    def list_plans(options={})
+      plans = []
+      list_plans_each(options) { |p| plans << p }
+      plans
+    end
+
+    # Public    - iterate through all plans
+    #
+    # options   - Hash of filter options
+    #             :data_source_uuid
+    #
+    # Returns an Enumerable that will yield a ChartMogul::Import::Plan for
+    # each record
+    def list_plans_each(options={}, &block)
+      params = { page_number: 1 }
+      params[:data_source_uuid] = options[:data_source_uuid] if options[:data_source_uuid]
+
+      paged_get("/v1/import/plans", params, :plans) do |plans|
+        plans.each do |plan|
+          yield Import::Plan.new(plan)
+        end
+      end
+    end
+
+    # Public - create a Plan
+    #
+    # args   - Hash of params see https://dev.chartmogul.com/docs/plans
+    #          Mandatory: :data_source_uuid, :name, :interval_count, :interval_unit
+    #
+    # Returns a ChartMogul::Import::Plan
+    def create_plan(args)
+      [:data_source_uuid, :name, :interval_unit, :interval_count].each do |attribute|
+        refute_blank! args[attribute], attribute
+      end
+      assert! (args[:interval_count].is_a?(Integer) && args[:interval_count] > 0), "interval_count must be an integer greater than zero"
+      assert! [:day, :month, :year].include?(args[:interval_unit].to_sym), "interval_unit must be one of :day, :month, :year"
+
+      response = connection.post do |request|
+        request.url "/v1/import/plans"
+        request.headers['Content-Type'] = "application/json"
+        request.body = args.to_json
+      end
+
+      Import::Plan.new(preprocess_response(response))
+    end
+  end
+end

data/lib/chart_mogul/version.rb

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

data/lib/chart_mogul.rb

@@ -0,0 +1,12 @@
+require "chart_mogul/assertive"
+require "chart_mogul/version"
+require "chart_mogul/import_api"
+require "chart_mogul/client"
+
+module ChartMogul
+
+  def self.client
+    @client ||= Client.new
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: chart_mogul
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Bird
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- adam.bird@gmail.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
+- chart_mogul.gemspec
+- lib/chart_mogul.rb
+- lib/chart_mogul/assertive.rb
+- lib/chart_mogul/client.rb
+- lib/chart_mogul/import/customer.rb
+- lib/chart_mogul/import/data_source.rb
+- lib/chart_mogul/import/plan.rb
+- lib/chart_mogul/import_api.rb
+- lib/chart_mogul/version.rb
+homepage: https://github.com/adambird/chart-mogul-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for working with the ChartMogul API
+test_files: []