pingboard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dddbd8a55fc10971311e036642adfd6d09575dd
+  data.tar.gz: 9ad143a7c4e3d0b6fc50ce65fb00cdc3ccfb11f7
+SHA512:
+  metadata.gz: 6aa39f72878ca072f33cedd4c168968e2de8b29f883f001d413d77a826d4c7bea2a3a2dea042f6dcd3f229fd9d15013b21ed49e7c08d1bf5cd08a4353ca993b4
+  data.tar.gz: a4fbcffccb1526273bc449c1f0f8095b0b34a1d1a876d6e218ec8642fcc4b4a47d784624bafc5fc8b0308bb35076df610f30cfe62dd08c4476ea45fc8c4e163c

data/README.md

@@ -0,0 +1,80 @@
+# Pingboard API Ruby Client
+
+[![Gem Version](https://badge.fury.io/rb/pingboard.svg)](https://rubygems.org/gems/pingboard)
+[![Build Status](https://travis-ci.org/bry/pingboard.svg)](https://travis-ci.org/bry/pingboard)
+
+The Ruby interface to the Pingboard API
+
+## Installation
+
+```
+gem install pingboard
+```
+
+## Configuration
+
+```ruby
+client = Pingboard::Client.new do |config|
+  config.service_app_id = 'service app id'
+  config.service_app_secret = 'service app secret'
+end
+```
+
+## Usage Examples
+After configuring a `client`, you can do the following:
+
+### Search
+Search for a Pingboard user
+```ruby
+client.search("Pingboard text query")
+```
+
+### Users
+Get all Pingboard users
+
+```ruby
+client.users
+```
+
+Get a Pingboard user by user ID
+
+```ruby
+client.user("12345")
+```
+
+### Status
+
+Get a Pingboard status by status ID
+```ruby
+client.status("12345")
+```
+
+### Status Types
+
+Get Pingboard's status types
+```ruby
+client.status_types
+```
+
+## License
+MIT License
+
+Copyright (c) 2017 Bryan B. Cabalo
+
+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/lib/pingboard.rb

@@ -0,0 +1,3 @@
+require 'faraday'
+require 'json'
+require 'pingboard/client'

data/lib/pingboard/client.rb

@@ -0,0 +1,90 @@
+module Pingboard
+  class Client
+
+    URL_HOSTNAME = 'https://app.pingboard.com'.freeze
+    URL_API_VERSION_PATH = '/api/v2'.freeze
+    URL_SEARCH_USERS_PATH = '/search/users'.freeze
+    URL_USERS_PATH = '/users'.freeze
+    URL_STATUSES_PATH = '/statuses'.freeze
+    URL_STATUS_TYPES_PATH = '/status_types'.freeze
+    URL_OAUTH_TOKEN_PATH = '/oauth/token'.freeze
+
+    attr_accessor :connection, :service_app_id, :service_app_secret,
+      :access_token, :token_expires_in, :token_expiration_time
+
+    def initialize(options={})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+      @token_expiration_time = Time.now
+    end
+
+    def search(query, options={})
+      options.merge(q: query)
+      perform_get_request(URL_API_VERSION_PATH + URL_SEARCH_USERS_PATH, options)
+    end
+
+    def users(options={})
+      perform_get_request(URL_API_VERSION_PATH + URL_USERS_PATH, options)
+    end
+
+    def user(user_id, options={})
+      perform_get_request(URL_API_VERSION_PATH + URL_USERS_PATH + "/#{user_id}", options)
+    end
+
+    def status(status_id, options={})
+      perform_get_request(URL_API_VERSION_PATH + URL_STATUSES_PATH + "/#{status_id}", options)
+    end
+
+    def status_types
+      perform_get_request(URL_API_VERSION_PATH + URL_STATUS_TYPES_PATH)
+    end
+
+
+    private
+
+    def connection
+      @connection = Faraday.new(url: URL_HOSTNAME)
+    end
+
+    def access_token_expired?
+      Time.now > token_expiration_time
+    end
+
+    def new_access_token
+      response_body = JSON.parse(access_token_request.body)
+      @token_expires_in = response_body['expires_in']
+      @token_expiration_time = Time.now + @token_expires_in.to_i
+      response_body['access_token']
+    end
+
+    def access_token
+      @access_token = new_access_token if access_token_expired?
+      @access_token
+    end
+
+    def access_token_request
+      @access_token_request = connection.post do |req|
+        req.url URL_OAUTH_TOKEN_PATH
+        req.params['grant_type'] = 'client_credentials'
+        req.body = {
+          client_id: service_app_id,
+          client_secret: service_app_secret
+        }
+      end
+    end
+
+    def perform_get_request(url_path, options={})
+      pingboard_response = connection.get do |req|
+        req.url "#{url_path}"
+        req.headers['Authorization'] = "Bearer #{access_token}"
+        options.each do |key, value|
+          req.params["#{key}"] = value
+        end
+      end
+
+      JSON.parse(pingboard_response.body)
+    end
+  end
+end

data/pingboard.gemspec

@@ -0,0 +1,16 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'pingboard'
+  s.version       = '0.0.1'
+  s.date          = '2017-07-16'
+  s.summary       = "The Pingboard API Ruby Client"
+  s.description   = "A Ruby client interface for the Pingboard API"
+  s.authors       = ["Bryan B. Cabalo"]
+  s.email         = 'bcabalo@gmail.com'
+  s.require_paths = %w(lib)
+  s.files         = %w(lib/pingboard.rb README.md pingboard.gemspec) + Dir['lib/**/*.rb']
+  s.homepage      = 'http://rubygems.org/gems/pingboard'
+  s.license       = 'MIT'
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: pingboard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bryan B. Cabalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-16 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby client interface for the Pingboard API
+email: bcabalo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/pingboard.rb
+- lib/pingboard/client.rb
+- pingboard.gemspec
+homepage: http://rubygems.org/gems/pingboard
+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: The Pingboard API Ruby Client
+test_files: []