callback-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90d9050e1b2f3fea4e06cf1cdb494be412246c93
+  data.tar.gz: 8fa6cace2c221ca716d858e6a60a0713d7a62709
+SHA512:
+  metadata.gz: 832576ccaeef14a14e6a327638cf96c7a1389a9dae4cc1a5339913d2c281a47fa1aed36121f40adcc0244d2c4d691ecff636f403fc244688c052a8b867e221c9
+  data.tar.gz: 7d4e2dc01a27266392c9d5b565c60e929c4741a781a375fe24823a4b12024e23a09cae36b57c7577bb3be60248add4fb84806c1a9a2a6012cca9ae5de3c12140

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jamie@brilliantfantastic.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    callback-ruby (0.0.1)
+      hashie
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.2)
+    hashie (3.4.6)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    public_suffix (2.0.5)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  callback-ruby!
+  rake
+  rspec (~> 3.5.0)
+  webmock
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Tatsu, 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,91 @@
+Callback.run Ruby API Wrapper
+=============================
+
+[ ![Codeship Status for callbackrun/callback-ruby](https://app.codeship.com/projects/2c3b5c50-fd0e-0134-c7bc-22bf4c6edae4/status?branch=master)](https://app.codeship.com/projects/211937)
+
+Ruby bindings for the Callback.run API (http://developers.callback.run)
+
+## DESCRIPTION
+
+Building scheduling systems takes precious cycles away from concentrating on the building business value. In addition, hosting costs increase to support running background jobs. Callback.run allows you to create recurring jobs that get scheduled and run on Callback's platform. When run, Callback will call a webhook on your servers.
+
+This is a Ruby wrapper around the Callback.run API to easily integrate Callback in your Ruby applications.
+
+## INSTALLATION
+
+```
+gem install callback
+```
+
+Using [Bunder](http://bundler.io/), add the following to your `Gemfile`:
+
+```
+gem "callback"
+```
+
+## BASIC USAGE
+
+### Configure the Client
+
+You can configure Callback to use the API key for your team. If you are using Rails, you will want to create an initializer at `config/initializers/callback.rb`
+
+```ruby
+Callback.configure do |config|
+  config.access_token = ENV["CALLBACK_ACCESS_TOKEN"]
+end
+```
+
+The following options are available for configuration:
+
+| Attribute      | Default                    |
+|----------------|----------------------------|
+| `access_token` | `nil`                      |
+| `base_path`    | `https://api.callback.run` |
+
+### Creating a Client
+
+There are several endpoints that hang off of the client. The first thing you want to do is create a client.
+
+```
+client = Callback::Client.new(access_token: "my_token")
+```
+
+If you leave the `access_token` option blank, it will use the access token specified when [configuring the client](#configure-the-client).
+
+### Jobs
+
+If you want to perform any CRUD operations on a job, you can use the `jobs` method off of the `Client`.
+
+#### Creating a job
+
+```
+job = client.jobs.create(callback_url: "https://example.com/hooks/users/324/welcome",
+                         payload: { account_id: 1234 })
+```
+
+#### Finding a job
+
+```
+job = client.jobs.find("https://example.com/hooks/users/324/welcome")
+```
+
+## CONTRIBUTING
+
+1. Clone the repository `git clone https://github.com/callbackrun/callback-ruby`
+1. Create a feature branch `git checkout -b my-awesome-feature`
+1. Codez!
+1. Commit your changes (small commits please)
+1. Push your new branch `git push origin my-awesome-feature`
+1. Create a pull request `hub pull-request -b callbackrun:master -h callbackrun:my-awesome-feature`
+
+Everyone interacting in Callback's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Callback [code of conduct](CODE_OF_CONDUCT.md).
+
+## RELEASING A NEW GEM
+
+1. Bump the VERSION in `lib/callback/version.rb`
+1. Commit changes and push to GitHub
+1. run `bundle exec rake release`
+
+## LICENSE
+
+This project is licensed under the [MIT License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :environment do
+  ENV["RACK_ENV"] ||= "development"
+  require "./lib/callback"
+end
+
+desc "Loads the appropriate libraries and then fires up irb"
+task :console => :environment do
+  exec "irb -r ./lib/callback.rb"
+end
+
+task default: :spec

data/callback-ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "callback/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "callback-ruby"
+  spec.version       = Callback::VERSION
+  spec.authors       = ["Jamie Wright"]
+  spec.email         = ["jamie@callback.run"]
+
+  spec.summary       = "A Ruby wrapper for the Callback API"
+  spec.description   = %q{Callback (http://callback.run) allows you to create a job that runs on a schedule and you get a webhook notification when the job should run. Stop building scheduling systems.}
+  spec.homepage      = "https://github.com/callbackrun/callback-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_dependency "hashie"
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "webmock"
+end

data/lib/callback.rb

@@ -0,0 +1,15 @@
+require "callback/api"
+require "callback/client"
+require "callback/configuration"
+require "callback/parser"
+require "callback/version"
+
+module Callback
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/lib/callback/api.rb

@@ -0,0 +1,2 @@
+require_relative "api/base"
+require_relative "api/jobs"

data/lib/callback/api/base.rb

@@ -0,0 +1,40 @@
+require "httparty"
+require "callback/parser"
+
+module Callback
+  module API
+    class Base
+      include Parser
+
+      attr_accessor :access_token, :base_path
+
+      def initialize(access_token: nil, base_path: nil)
+        @access_token = access_token
+        @base_path = base_path
+      end
+
+      protected
+
+      def request(method, path, parameters={})
+        full_path = "#{base_path}#{path}"
+
+        options = {
+          headers: {
+            "Accept"        => "application/json",
+            "Authorization" => "Bearer #{access_token}",
+            "Content-Type"  => "application/json; charset=utf-8"
+          },
+          format: :json
+        }
+        if method.to_sym == :post
+          options[:body] = parameters.to_json
+        else
+          options[:query] = parameters
+        end
+
+        response = HTTParty.send method, full_path, options
+        JSON.parse(response.body, symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/callback/api/jobs.rb

@@ -0,0 +1,16 @@
+module Callback
+  module API
+    class Jobs < Base
+      def create(parameters={})
+        parse request(:post, "/jobs", parameters)
+      end
+
+      def find(id_or_callback_url)
+        # TODO: This needs to be fixed on the server. It cannot parse periods
+
+        safe_id = CGI.escape(id_or_callback_url).gsub "\.", "%2E"
+        parse request(:get, "/jobs/#{safe_id}")
+      end
+    end
+  end
+end

data/lib/callback/client.rb

@@ -0,0 +1,20 @@
+module Callback
+  class Client
+    attr_accessor :access_token, :base_path
+
+    def initialize(options={})
+      @access_token = initialize_attribute :access_token, options
+      @base_path = initialize_attribute :base_path, options
+    end
+
+    def jobs
+      @jobs ||= API::Jobs.new(access_token: access_token, base_path: base_path)
+    end
+
+    private
+
+    def initialize_attribute(key, options)
+      options.fetch(key) { Callback.configuration.send(key) }
+    end
+  end
+end

data/lib/callback/configuration.rb

@@ -0,0 +1,9 @@
+module Callback
+  class Configuration
+    attr_accessor :access_token, :base_path
+
+    def initialize
+      @base_path = "https://api.callback.run"
+    end
+  end
+end

data/lib/callback/parser.rb

@@ -0,0 +1,9 @@
+require "hashie"
+
+module Callback
+  module Parser
+    def parse(json)
+      Hashie::Mash.new json
+    end
+  end
+end

data/lib/callback/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: callback-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jamie Wright
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: 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: bundler
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.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: Callback (http://callback.run) allows you to create a job that runs on
+  a schedule and you get a webhook notification when the job should run. Stop building
+  scheduling systems.
+email:
+- jamie@callback.run
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- callback-ruby.gemspec
+- lib/callback.rb
+- lib/callback/api.rb
+- lib/callback/api/base.rb
+- lib/callback/api/jobs.rb
+- lib/callback/client.rb
+- lib/callback/configuration.rb
+- lib/callback/parser.rb
+- lib/callback/version.rb
+homepage: https://github.com/callbackrun/callback-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.5.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Callback API
+test_files: []