baremetrics_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1bfbcb23380d81c89c0107640b7577caaa80df2
+  data.tar.gz: cae7ad5b59dc336d88d63b27b4806ad58616ae70
+SHA512:
+  metadata.gz: 252dc2c3e1894303baf12896ae5713abe8c5b11890ce612e705c9f5ecd9feaf2f3b34bf343491e24e09e7caafb0983ee898f3300b6c433065b4b0c4233a73769
+  data.tar.gz: 46cad942c6c0b470d806f9df297a5dea4406292166634af955afff788e97c2ba9c43482ea3fc005bff06668369ca9572127a40ce15da9a109027b72588d04dab

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in baremetrics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Third Blink Software Inc.
+
+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,89 @@
+# Baremetrics
+
+This is a Ruby Gem for the Baremetrics API developed by Rewind.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'baremetrics_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install baremetrics_api
+
+## Usage
+
+**Initializing the Client**
+
+This gem uses a client model for communication with the API. You initialize a client first with the desired configuration and then use it for making requests:
+
+```ruby
+client = BaremetricsAPI::Client.new(api_key: '1234')
+
+client.list_sources
+```
+
+The only required configuration parameter to initialize the client is the API key using this constructor. Unprovided parameters will have their default value set.
+
+You can also initialize the client using a configuration block to have it globally configured:
+
+```ruby
+BaremetricsAPI.client.configure do |config|
+  config.api_key = '123'
+  config.sandbox = false
+  config.response_limit = 30
+  config.log_traffic = false
+end
+
+BaremetricsAPI.client.list_source
+```
+
+Note that you must specify all the configuration parameters when using this method as they will not have a default value.
+
+**Configuration Parameters**
+
+`api_key`: String - The Baremetrics API key. Can be sandbox or production.
+
+`sandbox`: Boolean - Whether to use the sandbox or production API endpoint. (Default: false)
+
+`response_limit`: Integer - The amount of items to return per page for GET requests (Default: 30)
+
+`log_traffic`: Boolean - Output a log of requests and responses from the Baremetrics API (Default: false)
+
+**Making Requests**
+
+The gem tries to best match its method names to the name of the corresponding API call in the Baremetrics documentation.
+All API calls are available as methods on the client object.
+To list which calls are available run: `client.methods`
+
+The arguments required for each endpoint are named keywords. We tried to best match the names of the parameters as described in the Baremetrics API documentation.
+
+An example call would be:
+
+```ruby
+client.list_customers(source_id: '123')
+```
+
+The response to all calls is raw JSON that is returned from the Baremetrics API.
+
+**Rate Limiting**
+
+The Baremetrics API has a rate limit which refreshes per-hour. When the rate limit is exceeded, this gem will throw the following exception `Error::RateLimitExeeded`.
+
+You should rescue this exception and retry after an hour when the rate limit is refreshed.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rewindit/baremetrics.
+
+
+## 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/baremetrics.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'baremetrics_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'baremetrics_api'
+  spec.version       = BaremetricsAPI::VERSION
+  spec.authors       = ['Third Blink Software Inc']
+  spec.email         = ['help@rewindit.io']
+
+  spec.summary       = 'Ruby client library for Baremetrics V1 API'
+  spec.description   = 'Provides an easy way to interact with the Baremetrics API in any application.'
+  spec.homepage      = 'https://github.com/rewindit/baremetrics_api'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'faraday',  '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.11'
+  spec.add_dependency 'httpclient', '~> 2.8'
+  spec.add_dependency 'activesupport', '~> 4.2'
+end

data/bin/console

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

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/baremetrics_api/client.rb

@@ -0,0 +1,94 @@
+require 'baremetrics_api/configuration'
+require 'baremetrics_api/endpoint/account'
+require 'baremetrics_api/constants'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/rate_checker'
+require 'httpclient'
+require 'baremetrics_api/errors'
+require 'logger'
+require 'active_support/core_ext/hash'
+require 'json'
+
+module BaremetricsAPI
+  class Client
+    attr_reader :configuration
+
+    def initialize(options = nil)
+      @configuration = nil
+      append_request_methods_to_class
+
+      return if options.nil?
+
+      @configuration = Configuration.new(options)
+
+      ensure_valid_configuration
+    end
+
+    # Configure the API client
+    # @yield [Configuration] the configuration
+    # @example Basic configuration
+    #   BaremetricsAPI.client.configure do |config|
+    #     config.api_key = 'test123'
+    #     config.response_limit = '30'
+    #   end
+    def configure
+      raise Error::AlreadyConfigured unless @configuration.nil?
+
+      @configuration = Configuration.new
+      yield(@configuration)
+
+      ensure_valid_configuration
+    end
+
+    # Returns the raw Faraday connection configured using the current configuration
+    def connection
+      ensure_valid_configuration
+      host = configuration.sandbox ? Constants::SANDBOX_API_HOST : Constants::API_HOST
+      Faraday.new(host, headers: { authorization: "Bearer #{configuration.api_key}", content_type: 'application/json', accept: 'application/json' }) do |f|
+        f.request :json
+        f.response :logger if configuration.log_traffic
+        f.use Faraday::RateChecker
+        f.adapter :httpclient
+      end
+    end
+
+    private
+
+    def ensure_valid_configuration
+      if configuration.nil? || !configuration.valid?
+        # nil out the configuration so we can reconfigure
+        @configuration = nil
+        raise Error::MissingConfigurationKeys
+      else
+        # Lock in the configuration so it can't be changed during app usage
+        @configuration.freeze
+      end
+    end
+
+    # The methods below are responsible for appending methods from the
+    # endpoint classes onto the client. This allows for simple interaction
+    # with the gem.
+    # For example: client.retrieve_account instead of
+    # BaremetricsAPI::Endpoint::Account.new(client).retrieve_account
+
+    def append_request_methods_to_class
+      Constants::ENDPOINT_CLASSES.each do |endpoint_class|
+        endpoint_instance = endpoint_class.new(self)
+        create_methods_from_instance(endpoint_instance)
+      end
+    end
+
+    def create_methods_from_instance(instance)
+      instance.public_methods(false).each do |method_name|
+        add_method(instance, method_name)
+      end
+    end
+
+    def add_method(instance, method_name)
+      define_singleton_method(method_name) do |*args|
+        instance.public_send(method_name, *args)
+      end
+    end
+  end
+end

data/lib/baremetrics_api/configuration.rb

@@ -0,0 +1,27 @@
+require 'baremetrics_api/constants'
+
+module BaremetricsAPI
+  class Configuration
+    CONFIG_KEYS = Constants::CONFIG_KEYS
+
+    attr_accessor *CONFIG_KEYS
+
+    def initialize(configuration = nil)
+      return unless configuration.is_a?(Hash)
+
+      configuration.each do |name, value|
+        send("#{name}=", value)
+      end
+
+      # Default to false
+      self.sandbox = false if sandbox.nil?
+      self.log_traffic = false if log_traffic.nil?
+      self.response_limit = Constants::DEFAULT_RESPONSE_LIMIT
+    end
+
+    # A configuration is valid if none of the keys are nil
+    def valid?
+      CONFIG_KEYS.none? { |key| send(key).nil? }
+    end
+  end
+end

data/lib/baremetrics_api/constants.rb

@@ -0,0 +1,26 @@
+require 'baremetrics_api/endpoint/account'
+require 'baremetrics_api/endpoint/annotations'
+require 'baremetrics_api/endpoint/charges'
+require 'baremetrics_api/endpoint/customers'
+require 'baremetrics_api/endpoint/events'
+require 'baremetrics_api/endpoint/goals'
+require 'baremetrics_api/endpoint/metrics'
+require 'baremetrics_api/endpoint/plans'
+require 'baremetrics_api/endpoint/sources'
+require 'baremetrics_api/endpoint/subscriptions'
+require 'baremetrics_api/endpoint/users'
+
+module BaremetricsAPI
+  class Constants
+    API_HOST = 'https://api.baremetrics.com/v1'.freeze
+    SANDBOX_API_HOST = 'https://api-sandbox.baremetrics.com/v1'.freeze
+    CONFIG_KEYS = [:api_key, :response_limit, :sandbox, :log_traffic].freeze
+    DEFAULT_RESPONSE_LIMIT = 30
+
+    # Endpoints
+    ENDPOINT_CLASSES = [BaremetricsAPI::Endpoint::Account, BaremetricsAPI::Endpoint::Annotations, BaremetricsAPI::Endpoint::Charges,
+                        BaremetricsAPI::Endpoint::Customers, BaremetricsAPI::Endpoint::Events, BaremetricsAPI::Endpoint::Goals,
+                        BaremetricsAPI::Endpoint::Metrics, BaremetricsAPI::Endpoint::Plans, BaremetricsAPI::Endpoint::Sources,
+                        BaremetricsAPI::Endpoint::Subscriptions, BaremetricsAPI::Endpoint::Users].freeze
+  end
+end

data/lib/baremetrics_api/endpoint/account.rb

@@ -0,0 +1,23 @@
+module BaremetricsAPI
+  module Endpoint
+    class Account
+      PATH = 'account'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get_account
+        JSON.parse(account_request.body).with_indifferent_access
+      end
+
+      private
+
+      def account_request
+        @client.connection.get do |req|
+          req.url PATH
+        end
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/annotations.rb

@@ -0,0 +1,59 @@
+module BaremetricsAPI
+  module Endpoint
+    class Annotations
+      PATH = 'annotations'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_annotations(page: nil)
+        JSON.parse(list_annotations_request(page).body).with_indifferent_access
+      end
+
+      def show_annotation(id:)
+        JSON.parse(show_annotation_request(id).body).with_indifferent_access
+      end
+
+      def create_annotation(annotation_params:)
+        JSON.parse(create_annotation_request(annotation_params).body).with_indifferent_access
+      end
+
+      def delete_annotation(id:)
+        JSON.parse(delete_annotation_request(id).body).with_indifferent_access
+      end
+
+      private
+
+      def list_annotations_request(page)
+        query_params = {
+          per_page: @client.configuration.response_limit
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url PATH
+          req.params = query_params
+        end
+      end
+
+      def show_annotation_request(id)
+        @client.connection.get do |req|
+          req.url "#{PATH}/#{id}"
+        end
+      end
+
+      def create_annotation_request(annotation_params)
+        @client.connection.post do |req|
+          req.url PATH
+          req.body = annotation_params
+        end
+      end
+
+      def delete_annotation_request(id)
+        @client.connection.delete "#{PATH}/#{id}"
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/charges.rb

@@ -0,0 +1,51 @@
+module BaremetricsAPI
+  module Endpoint
+    class Charges
+      PATH = 'charges'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_charges(source_id:, page: nil)
+        JSON.parse(list_charges_request(source_id, page).body).with_indifferent_access
+      end
+
+      def show_charge(source_id:, oid:)
+        JSON.parse(show_charge_request(source_id, oid).body).with_indifferent_access
+      end
+
+      def create_charge(source_id:, charge_params:)
+        JSON.parse(create_charge_request(source_id, charge_params).body).with_indifferent_access
+      end
+
+      private
+
+      def list_charges_request(source_id)
+        query_params = {
+          per_page: @client.configuration.response_limit
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}"
+          req.params = query_params
+        end
+      end
+
+      def show_charge_request(source_id, oid)
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}/#{oid}"
+        end
+      end
+
+      def create_charge_request(source_id, charge_params)
+        client.connection.post do |req|
+          req.url "#{source_id}/#{PATH}"
+          req.body = charge_params
+        end
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/customers.rb

@@ -0,0 +1,88 @@
+module BaremetricsAPI
+  module Endpoint
+    class Customers
+      PATH = 'customers'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_customers(source_id: nil, search: nil, page: nil)
+        JSON.parse(list_customers_request(source_id, search, page).body).with_indifferent_access
+      end
+
+      def show_customer(source_id:, oid:)
+        JSON.parse(show_customer_request(source_id, oid).body).with_indifferent_access
+      end
+
+      def list_customer_events(source_id:, oid:, page: nil)
+        JSON.parse(list_customer_events_request(source_id, oid, page).body).with_indifferent_access
+      end
+
+      def update_customer(customer_oid:, source_id:, customer_params:)
+        JSON.parse(update_customer_request(customer_oid, source_id, customer_params).body).with_indifferent_access
+      end
+
+      def create_customer(source_id:, customer_params:)
+        JSON.parse(create_customer_request(source_id, customer_params).body).with_indifferent_access
+      end
+
+      def delete_customer(oid:, source_id:)
+        JSON.parse(delete_customer_request(oid, source_id).body).with_indifferent_access
+      end
+
+      private
+
+      def list_customers_request(source_id, search, page)
+        query_params = {
+          per_page: @client.configuration.response_limit
+        }
+
+        query_params[:search] = search unless search.nil?
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url source_id.nil? ? PATH : "#{source_id}/#{PATH}"
+          req.params = query_params
+        end
+      end
+
+      def show_customer_request(source_id, oid)
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}/#{oid}"
+        end
+      end
+
+      def list_customer_events_request(source_id, oid, page)
+        query_params = {
+          per_page: @client.configuration.response_limit
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}/#{oid}/events"
+          req.params = query_params
+        end
+      end
+
+      def update_customer_request(customer_oid, source_id, customer_params)
+        @client.connection.put do |req|
+          req.url "#{source_id}/#{PATH}/#{customer_oid}"
+          req.body = customer_params
+        end
+      end
+
+      def create_customer_request(source_id, customer_params)
+        @client.connection.post do |req|
+          req.url "#{source_id}/#{PATH}"
+          req.body = customer_params
+        end
+      end
+
+      def delete_customer_request(oid, source_id)
+        @client.connection.delete "#{source_id}/#{PATH}/#{oid}"
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/events.rb

@@ -0,0 +1,41 @@
+module BaremetricsAPI
+  module Endpoint
+    class Events
+      PATH = 'events'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_events(source_id:, live_stream: false, page: nil)
+        JSON.parse(list_events_request(source_id, live_stream, page).body).with_indifferent_access
+      end
+
+      def show_event(source_id:, id:)
+        JSON.parse(show_event_request(source_id, id).body).with_indifferent_access
+      end
+
+      private
+
+      def list_events_request(source_id, live_stream, page)
+        query_params = {
+          per_page: @client.configuration.response_limit,
+          live_stream: live_stream
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}"
+          req.params = query_params
+        end
+      end
+
+      def show_event_request(source_id, id)
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/goals.rb

@@ -0,0 +1,59 @@
+module BaremetricsAPI
+  module Endpoint
+    class Goals
+      PATH = 'goals'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_goals(page: nil)
+        JSON.parse(list_goals_request(page).body).with_indifferent_access
+      end
+
+      def show_goal(id:)
+        JSON.parse(show_goal_request(id).body).with_indifferent_access
+      end
+
+      def create_goal(goal_params:)
+        JSON.parse(create_goal_request(goal_params).body).with_indifferent_access
+      end
+
+      def delete_goal(id:)
+        JSON.parse(delete_goal_request(id).body).with_indifferent_access
+      end
+
+      private
+
+      def list_goals_request(page)
+        query_params = {
+          per_page: @client.configuration.response_limit
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url PATH
+          req.params = query_params
+        end
+      end
+
+      def show_goal_request(id)
+        @client.connection.get do |req|
+          req.url "#{PATH}/#{id}"
+        end
+      end
+
+      def create_goal_request(goal_params)
+        @client.connection.post do |req|
+          req.url PATH
+          req.body = goal_params
+        end
+      end
+
+      def delete_goal_request(id)
+        @client.connection.delete "#{PATH}/#{id}"
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/metrics.rb

@@ -0,0 +1,90 @@
+module BaremetricsAPI
+  module Endpoint
+    class Metrics
+      PATH = 'metrics'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def show_summary(start_date:, end_date:, page: nil)
+        JSON.parse(show_summary_request(start_date, end_date, page).body).with_indifferent_access
+      end
+
+      def show_metric(metric:, start_date:, end_date:, compare_to: 30, page: nil)
+        JSON.parse(show_metric_request(metric, start_date, end_date, compare_to, page).body).with_indifferent_access
+      end
+
+      def show_customers(metric:, start_date:, end_date:, page: nil)
+        JSON.parse(show_customers_request(metric, start_date, end_date, page).body).with_indifferent_access
+      end
+
+      def show_plan_breakout(metric:, start_date:, end_date:, page: nil)
+        JSON.parse(show_plan_breakout_request(metric, start_date, end_date, page).body).with_indifferent_access
+      end
+
+      private
+
+      def show_summary_request(start_date, end_date, page)
+        query_params = {
+          per_page: @client.configuration.response_limit,
+          start_date: start_date,
+          end_date: end_date
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url PATH
+          req.params = query_params
+        end
+      end
+
+      def show_metric_request(metric, start_date, end_date, compare_to, page)
+        query_params = {
+          per_page: @client.configuration.response_limit,
+          start_date: start_date,
+          end_date: end_date,
+          compare_to: compare_to
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url "#{PATH}/#{metric}"
+          req.params = query_params
+        end
+      end
+
+      def show_customers_request(metric, start_date, end_date)
+        query_params = {
+          per_page: @client.configuration.response_limit,
+          start_date: start_date,
+          end_date: end_date
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url "#{PATH}/#{metric}/customers"
+          req.params = query_params
+        end
+      end
+
+      def show_plan_breakout_request(metric, start_date, end_date)
+        query_params = {
+          per_page: @client.configuration.response_limit,
+          start_date: start_date,
+          end_date: end_date
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url "#{PATH}/#{metric}/plans"
+          req.params = query_params
+        end
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/plans.rb

@@ -0,0 +1,71 @@
+module BaremetricsAPI
+  module Endpoint
+    class Plans
+      PATH = 'plans'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_plans(source_id: nil, search: nil, page: nil)
+        JSON.parse(list_plans_request(source_id, search, page).body).with_indifferent_access
+      end
+
+      def show_plan(source_id:, oid:)
+        JSON.parse(show_plan_request(source_id, oid).body).with_indifferent_access
+      end
+
+      def update_plan(plan_oid:, source_id:, plan_params:)
+        JSON.parse(update_plan_request(plan_oid, source_id, plan_params).body).with_indifferent_access
+      end
+
+      def create_plan(source_id:, plan_params:)
+        JSON.parse(create_plan_request(source_id, plan_params).body).with_indifferent_access
+      end
+
+      def delete_plan(oid:, source_id:)
+        JSON.parse(delete_plan_request(oid, source_id).body).with_indifferent_access
+      end
+
+      private
+
+      def list_plans_request(source_id, search, page)
+        query_params = {
+          per_page: @client.configuration.response_limit
+        }
+
+        query_params[:search] = search unless search.nil?
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url source_id.nil? ? PATH : "#{source_id}/#{PATH}"
+          req.params = query_params
+        end
+      end
+
+      def show_plan_request(source_id, oid)
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}/#{oid}"
+        end
+      end
+
+      def update_plan_request(plan_oid, source_id, plan_params)
+        @client.connection.put do |req|
+          req.url "#{source_id}/#{PATH}/#{plan_oid}"
+          req.body = plan_params
+        end
+      end
+
+      def create_plan_request(source_id, plan_params)
+        @client.connection.post do |req|
+          req.url "#{source_id}/#{PATH}"
+          req.body = plan_params
+        end
+      end
+
+      def delete_plan_request(oid, source_id)
+        @client.connection.delete "#{source_id}/#{PATH}/#{oid}"
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/sources.rb

@@ -0,0 +1,23 @@
+module BaremetricsAPI
+  module Endpoint
+    class Sources
+      PATH = 'sources'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_sources
+        JSON.parse(sources_request.body).with_indifferent_access
+      end
+
+      private
+
+      def sources_request
+        @client.connection.get do |req|
+          req.url PATH
+        end
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/subscriptions.rb

@@ -0,0 +1,82 @@
+module BaremetricsAPI
+  module Endpoint
+    class Subscriptions
+      PATH = 'subscriptions'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_subscriptions(source_id: nil, customer_oid: nil, page: nil)
+        JSON.parse(list_subscriptions_request(source_id, customer_oid, page).body).with_indifferent_access
+      end
+
+      def show_subscription(source_id:, oid:)
+        JSON.parse(show_subscription_request(source_id, oid).body).with_indifferent_access
+      end
+
+      def update_subscription(subscription_oid:, source_id:, subscription_params:)
+        JSON.parse(update_subscription_request(subscription_oid, source_id, subscription_params).body).with_indifferent_access
+      end
+
+      def cancel_subscription(subscription_oid:, source_id:, canceled_at:)
+        JSON.parse(cancel_subscription_request(subscription_oid, source_id, canceled_at).body).with_indifferent_access
+      end
+
+      def create_subscription(source_id:, subscription_params:)
+        JSON.parse(create_subscription_request(source_id, subscription_params).body).with_indifferent_access
+      end
+
+      def delete_subscription(oid:, source_id:)
+        JSON.parse(delete_subscription_request(oid, source_id).body).with_indifferent_access
+      end
+
+      private
+
+      def list_subscriptions_request(source_id, customer_oid, page)
+        query_params = {
+          per_page: @client.configuration.response_limit,
+          customer_oid: customer_oid
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url source_id.nil? ? PATH : "#{source_id}/#{PATH}"
+          req.params = query_params
+        end
+      end
+
+      def show_subscription_request(source_id, oid)
+        @client.connection.get do |req|
+          req.url "#{source_id}/#{PATH}/#{oid}"
+        end
+      end
+
+      def update_subscription_request(subscription_oid, source_id, subscription_params)
+        @client.connection.put do |req|
+          req.url "#{source_id}/#{PATH}/#{subscription_oid}"
+          req.body = subscription_params
+        end
+      end
+
+      def cancel_subscription_request(subscription_oid, source_id, canceled_at)
+        @client.connection.put do |req|
+          req.url "#{source_id}/#{PATH}/#{subscription_oid}/cancel"
+          req.body = { canceled_at: canceled_at }
+        end
+      end
+
+      def create_subscription_request(source_id, subscription_params)
+        @client.connection.post do |req|
+          req.url "#{source_id}/#{PATH}"
+          req.body = subscription_params
+        end
+      end
+
+      def delete_subscription_request(oid, source_id)
+        @client.connection.delete "#{source_id}/#{PATH}/#{oid}"
+      end
+    end
+  end
+end

data/lib/baremetrics_api/endpoint/users.rb

@@ -0,0 +1,40 @@
+module BaremetricsAPI
+  module Endpoint
+    class Users
+      PATH = 'users'.freeze
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list_users(page: nil)
+        JSON.parse(list_users_request(page).body).with_indifferent_access
+      end
+
+      def show_user(id:)
+        JSON.parse(show_user_request(id).body).with_indifferent_access
+      end
+
+      private
+
+      def list_users_request(page)
+        query_params = {
+          per_page: @client.configuration.response_limit
+        }
+
+        query_params[:page] = page unless page.nil?
+
+        @client.connection.get do |req|
+          req.url PATH
+          req.params = query_params
+        end
+      end
+
+      def show_user_request(id)
+        @client.connection.get do |req|
+          req.url "#{PATH}/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/baremetrics_api/errors.rb

@@ -0,0 +1,21 @@
+module BaremetricsAPI
+  module Error
+    class MissingConfigurationKeys < StandardError
+      def initialize(msg = 'One or more required configuration keys are missing or invalid')
+        super
+      end
+    end
+
+    class AlreadyConfigured < StandardError
+      def initialize(msg = 'Client has already been configured')
+        super
+      end
+    end
+
+    class RateLimitExeeded < StandardError
+      def initialize(msg = 'You have exeeded your rate limit')
+        super
+      end
+    end
+  end
+end

data/lib/baremetrics_api/version.rb

@@ -0,0 +1,3 @@
+module BaremetricsAPI
+  VERSION = "0.1.0"
+end

data/lib/baremetrics_api.rb

@@ -0,0 +1,8 @@
+require 'baremetrics_api/version'
+require 'baremetrics_api/client'
+
+module BaremetricsAPI
+  def self.client
+    @client ||= BaremetricsAPI::Client.new
+  end
+end

data/lib/faraday/rate_checker.rb

@@ -0,0 +1,17 @@
+require 'baremetrics_api/errors'
+
+module Faraday
+  class RateChecker < Faraday::Middleware
+    def initialize(app)
+      super(app)
+    end
+
+    def call(request_env)
+      @app.call(request_env).on_complete do |response_env|
+        if response_env[:body].include?('You have exceeded your rate limit')
+          raise BaremetricsAPI::Error::RateLimitExeeded
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: baremetrics_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Third Blink Software Inc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '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: 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: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Provides an easy way to interact with the Baremetrics API in any application.
+email:
+- help@rewindit.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- baremetrics.gemspec
+- bin/console
+- bin/setup
+- lib/baremetrics_api.rb
+- lib/baremetrics_api/client.rb
+- lib/baremetrics_api/configuration.rb
+- lib/baremetrics_api/constants.rb
+- lib/baremetrics_api/endpoint/account.rb
+- lib/baremetrics_api/endpoint/annotations.rb
+- lib/baremetrics_api/endpoint/charges.rb
+- lib/baremetrics_api/endpoint/customers.rb
+- lib/baremetrics_api/endpoint/events.rb
+- lib/baremetrics_api/endpoint/goals.rb
+- lib/baremetrics_api/endpoint/metrics.rb
+- lib/baremetrics_api/endpoint/plans.rb
+- lib/baremetrics_api/endpoint/sources.rb
+- lib/baremetrics_api/endpoint/subscriptions.rb
+- lib/baremetrics_api/endpoint/users.rb
+- lib/baremetrics_api/errors.rb
+- lib/baremetrics_api/version.rb
+- lib/faraday/rate_checker.rb
+homepage: https://github.com/rewindit/baremetrics_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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client library for Baremetrics V1 API
+test_files: []