profitwell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b43f262780dd9b34d65ea5ea562d9af637fe89821dfa4b34f2e129fe11e2d6cf
+  data.tar.gz: 59e9099c2f3932ea54a2a10aab4bd8d51a4b70bfcbde79d1a01ee91c536dae39
+SHA512:
+  metadata.gz: 385fb0f5b0221c4ef07db19e7d8e3f27911aa4a2cd5a0b63543c21d47dc0c34bbae099975f85fa87b60ec7cb81689cbe3d47878450e4157c87ea26e0dd506b95
+  data.tar.gz: 0b153bccfab9732778de79f13f1fa91baea081425817d5b619ce1a2718280cdec70d8b43c7012f899e151d57e4df790b6d3b9914839f78e87dcc835f96063b6a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.1.4

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 eebasadre20@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 profitwell.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,47 @@
+# The Profitwell API Ruby Gem
+
+A simple and easy to use Ruby wrapper for ProfitWell's REST API.
+
+ProfitWell is the first business intelligence platform to bring together all of your recurring revenue business's financial, usage, and attribution data to one place that's insight laden, absolutely accurate, and 100% free.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'profitwell'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install profitwell
+
+## Usage
+
+```
+Profitwell.config do | config |
+    config.access_token = "<access_token_from_profitwell>"
+end
+
+## 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/eebasadre20/profitwell-ruby. 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/eebasadre20/profitwell-ruby/blob/master/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 Profitwell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/eebasadre20/profitwell-ruby/blob/master/CODE_OF_CONDUCT.md).

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 "profitwell"
+
+# 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/profitwell.rb

@@ -0,0 +1,30 @@
+require "httparty"
+require "oj"
+require "profitwell/configuration"
+require "profitwell/exception"
+require "profitwell/common"
+require "profitwell/client"
+require "profitwell/users"
+require "profitwell/version"
+
+module Profitwell
+  class Error < StandardError; end
+
+  extend Configuration
+
+  RESOURCES = %w(users plans subscriptions)
+
+  class << self
+    RESOURCES.each do | resource |
+      define_method resource do | resource_id = nil |
+        klass_name(resource).new
+      end
+    end
+
+    private
+
+    def klass_name(resource)
+      "Profitwell::#{resource.capitalize}".split("::").inject(Object) { |o, c| o.const_get c }
+    end
+  end
+end

data/lib/profitwell/client.rb

@@ -0,0 +1,12 @@
+module Profitwell
+  module Client
+    include Common
+
+    def api_status
+      request(
+        "get",
+        resource_path("api-status")
+      )
+    end
+  end
+end

data/lib/profitwell/common.rb

@@ -0,0 +1,68 @@
+module Profitwell
+  module Common
+    include HTTParty
+
+    ERROR_CODES = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      404 => NotFound,
+      502 => BadGateway,
+    }.freeze
+
+    def resource_path(path = nil, options = "")
+      return "#{base_endpoint}/#{path}/?#{options}" if options.nil?
+
+      "#{base_endpoint}/#{path}/"
+    end
+
+    def request(http_method, endpoint, options: {})
+      response = HTTParty.send(http_method, endpoint, params(options).merge!(authorization_header))
+      if response.success?
+        parse_success response
+      else
+        parse_failed response
+      end
+    end
+
+    private
+
+    def params(values)
+      {
+        body: values.to_json
+      }
+    end
+
+    def authorization_header
+      @authorization_header ||= {
+        headers: {
+          'Content-Type': content_type,
+          'Authorization': access_token
+        }
+      }
+    end
+
+    def parse_success(response)
+      response_hash = response
+    end
+
+    def parse_failed(response)
+      error = ERROR_CODES[response.code].new(response)
+      raise error, error.message
+    end
+
+    def access_token
+      raise 'Access token is missing' unless Profitwell.access_token
+      @access_token ||= Profitwell.access_token
+    end
+
+    def content_type
+      raise 'Content type is missing' unless Profitwell.content_type
+      @content_type ||= Profitwell.content_type
+    end
+
+    def base_endpoint
+      raise 'Base API endpoint is missing' unless Profitwell.base_endpoint
+      @base_endpoint ||= Profitwell.base_endpoint
+    end
+  end
+end

data/lib/profitwell/configuration.rb

@@ -0,0 +1,32 @@
+module Profitwell
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :version,
+      :base_endpoint,
+      :content_type,
+    ].freeze
+
+    DEFAULT_ACCESS_TOKEN  = nil
+    DEFAULT_VERSION       = "v2".freeze
+    DEFAULT_BASE_ENDPOINT      = "https://api.profitwell.com/v2".freeze
+    DEFAULT_CONTENT_TYPE  = "application/json".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def config
+      yield self if block_given?
+    end
+
+    def reset
+      self.access_token = DEFAULT_ACCESS_TOKEN
+      self.version      = DEFAULT_VERSION
+      self.base_endpoint     = DEFAULT_BASE_ENDPOINT
+      self.content_type = DEFAULT_CONTENT_TYPE
+    end
+  end
+end

data/lib/profitwell/exception.rb

@@ -0,0 +1,33 @@
+module Profitwell
+  class Error < StandardError
+    attr_reader :message, :type, :code, :error
+
+    FAILED_HTTP_STATUSES = Array(400..599)
+
+    def initialize(response)
+      # body = JSON.parse(response.body)
+
+      # @code = "#{response[:status]}"
+      # @type = body['meta']['error_type']
+      # @message = body['meta']['error_message']
+      @code = response.code
+      @error = FAILED_HTTP_STATUSES.include? response.code
+      @message = response
+    end
+  end
+
+  class RuntimeError < Error
+  end
+
+  class BadRequest < Error
+  end
+
+  class NotFound < Error
+  end
+
+  class BadGateway < Error
+  end
+
+  class Unauthorized < Error
+  end
+end

data/lib/profitwell/users.rb

@@ -0,0 +1,12 @@
+module Profitwell
+  class Users
+    include Client
+
+     def subscriptions(user_alias = nil)
+      request(
+        "get",
+        resource_path("users/#{user_alias}")
+      )
+    end
+  end
+end

data/lib/profitwell/version.rb

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

data/profitwell.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/profitwell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "profitwell"
+  spec.version       = Profitwell::VERSION
+  spec.authors       = ["eebasadre20"]
+  spec.email         = ["eebasadre20@gmail.com"]
+
+  spec.summary       = "Profitwell Ruby API Wrapper"
+  spec.description   = "Profitwell Ruby API Wrapper"
+  spec.homepage      = "https://github.com/eebasadre20/profitwell"
+  spec.license       = "MIT"
+  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/eebasadre20/profitwell"
+  spec.metadata["changelog_uri"] = "https://github.com/eebasadre20/profitwell/CHANGELOG.md"
+
+  # 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"]
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "oj"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: profitwell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- eebasadre20
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Profitwell Ruby API Wrapper
+email:
+- eebasadre20@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/profitwell.rb
+- lib/profitwell/client.rb
+- lib/profitwell/common.rb
+- lib/profitwell/configuration.rb
+- lib/profitwell/exception.rb
+- lib/profitwell/users.rb
+- lib/profitwell/version.rb
+- profitwell.gemspec
+homepage: https://github.com/eebasadre20/profitwell
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/eebasadre20/profitwell
+  source_code_uri: https://github.com/eebasadre20/profitwell
+  changelog_uri: https://github.com/eebasadre20/profitwell/CHANGELOG.md
+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.2
+signing_key: 
+specification_version: 4
+summary: Profitwell Ruby API Wrapper
+test_files: []