sendowl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d8116e7166cf1ba6cc5d3dafbce5859f5e08626fff048a39f49c8ec405aa7e4
+  data.tar.gz: 066e82ebec298ab61d3ce6a11fdb8af91ce0e5c7fa3c66353d99c576e10c530e
+SHA512:
+  metadata.gz: 64f3cd0c9664f7d221fbb729ae55930e66898a3ed7906f980e67dad6a2d2ce5f6c14c3468f56945ed11a55d108d0127ee842b34e918d7674147bc646e6669b02
+  data.tar.gz: 0c3423fc0f055fd7de977f540f0eb08296b4a5de260ef882c273dd49e9f050ffaccd17d3121fb66f494a559fcae5de8b74fd277be97601ffe0fc221ad132f6c3

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

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 tdtadeu@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sendowl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Thiago Dias
+
+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,80 @@
+# Sendowl
+
+Ruby client for Send Owl. Check it out at [SendOwl](https://www.sendowl.com/)
+
+## Getting Started
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sendowl"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendowl
+
+### Configure your API key and API secret
+
+You can set your API key/secret in Ruby:
+
+```ruby
+Sendowl.api_key        = "YOUR_API_KEY"
+Sendowl.api_secret     = "YOUR_API_SECRET"
+```
+
+or set the environment variable _SENDOWL\_API\_KEY_ (**recommended**)
+and _SENDOWL\_API\_SECRET_ (**recommended if needed**)
+
+## Usage
+
+So far, one single feature from the whole platform is available: Licenses.
+
+### Licenses
+
+#### Validating a License Key
+
+To validate a License Key, all you need to do is the following:
+
+```ruby
+Sendowl::License.new(product_id: 1, key: "ABCD-1234-EFGH-5678").valid?
+```
+
+This returns `true` or `false`
+
+## Contributing
+
+### TODO
+
+As you may have noticed, this gem is in construction and most features are not yet
+available. So support to Products, Bundles, Subscriptions, Drip Items etc are
+missing and I welcome any effort to help supporting those features.
+
+This gem also needs specs and, since it's been brought to life in a hurry
+because I only needed one feature of it, has no open source CI configured nor
+anything that remotely guarantees its stability. So help in making it stable is
+also welcome.
+
+### 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).
+
+### Bugs and Issues
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tdtadeu/sendowl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Sendowl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tdtadeu/sendowl/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 "sendowl"
+
+# 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/sendowl/request.rb

@@ -0,0 +1,56 @@
+require "uri"
+require "rest_client"
+require "json"
+
+module Sendowl
+  class Request
+    attr_accessor :model, :path, :method, :parameters, :headers, :query
+
+    DEFAULT_HEADERS = {
+      'Content-Type' => 'application/json; charset=utf8',
+      'Accept'       => 'application/json',
+      'User-Agent'   => "sendowl-ruby/#{Sendowl::VERSION}"
+    }
+
+    def initialize(path, method, model, options={})
+      @path       = path
+      @method     = method
+      @model      = model
+      @parameters = options[:params]  || {}
+      @query      = options[:query]   || {}
+      @headers    = options[:headers] || {}
+    end
+
+    def run
+      response = RestClient::Request.execute request_params
+      JSON.parse response.body
+    end
+
+    def call
+      model.parse run
+    end
+
+    protected
+
+    def request_params
+      {
+        method:       method,
+        user:         Sendowl.api_key,
+        password:     Sendowl.api_secret,
+        url:          api_url,
+        payload:      JSON.generate(parameters),
+        open_timeout: Sendowl.open_timeout,
+        timeout:      Sendowl.timeout,
+        headers:      DEFAULT_HEADERS.merge(headers),
+        ssl_version:  'TLSv1_2'
+      }
+    end
+
+    def api_url
+      url = Sendowl.api_endpoint + path
+      url += '?' + URI.encode_www_form(query) unless query.empty?
+
+      url
+    end
+  end
+end

data/lib/sendowl/resources/license.rb

@@ -0,0 +1,47 @@
+module Sendowl
+  class License
+    attr_reader :id, :order_id, :product_id, :key, :order_refunded
+
+    def initialize(product_id:, key:, id: nil, order_id: nil, order_refunded: nil)
+      @id = id
+      @order_id = order_id
+      @product_id = product_id
+      @key = key
+      @order_refunded = order_refunded
+    end
+
+    def valid?
+      license = Sendowl::Request.new(
+        check_valid_path,
+        "GET",
+        self.class,
+        { query: { key: key } }
+      ).call.first
+
+      !(license.nil? || license.order_id.nil? || license.order_refunded)
+    end
+
+    class << self
+      def parse(response)
+        case response
+        when Array
+          response.map { |x| parse x }
+        when Hash
+          if response["licenses"]
+            response["licenses"]["invalid_keys"]
+          else
+            new response["license"].transform_keys { |k| k.to_sym }
+          end
+        else
+          response
+        end
+      end
+    end
+
+    private
+
+    def check_valid_path
+      "/products/#{product_id}/licenses/check_valid"
+    end
+  end
+end

data/lib/sendowl/version.rb

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

data/lib/sendowl.rb

@@ -0,0 +1,16 @@
+require_relative "sendowl/version"
+require_relative "sendowl/request"
+
+require_relative "sendowl/resources/license"
+
+module Sendowl
+  class << self
+    attr_accessor :api_endpoint, :open_timeout, :timeout, :api_key, :api_secret
+  end
+
+  self.api_endpoint   = "https://www.sendowl.com/api/v1"
+  self.open_timeout   = 10
+  self.timeout        = 30
+  self.api_key        = ENV["SENDOWL_API_KEY"]
+  self.api_secret     = ENV["SENDOWL_API_SECRET"]
+end

data/sendowl.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sendowl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sendowl"
+  spec.version       = Sendowl::VERSION
+  spec.authors       = ["Thiago Dias"]
+  spec.email         = ["tdtadeu@gmail.com"]
+
+  spec.summary       = %q{Ruby client for SendOwl Digital Products platform}
+  spec.homepage      = "https://github.com/tdtadeu/sendowl"
+  spec.license       = "MIT"
+
+  # 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "vcr"
+
+  spec.add_dependency "rest-client"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: sendowl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thiago Dias
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: rest-client
+  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'
+description: 
+email:
+- tdtadeu@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
+- lib/sendowl.rb
+- lib/sendowl/request.rb
+- lib/sendowl/resources/license.rb
+- lib/sendowl/version.rb
+- sendowl.gemspec
+homepage: https://github.com/tdtadeu/sendowl
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for SendOwl Digital Products platform
+test_files: []