classy_plivo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 319d9a4ada1a05f394bd3d77fb4f4d55862a8038
+  data.tar.gz: 236e725fd6da9f8b19673c247ccbf98a3eb4153f
+SHA512:
+  metadata.gz: 79738e1a4a175f6656045006caed17b0982342f9ff8a4ed2a1f8f3e02de3157569369ef18a5aae54ae6c5ff1990ed886617e55da696678490e7fe8a39027c1a2
+  data.tar.gz: 0ba13573698a1ca99d002263e9c276f7d43029b03f912254954f2692fc52bb54df2d03833a0afb7a41440edbd501178563c68ec653b419e280cfd7ce5f64859f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: bundle exec rake test
+rvm:
+  - 2.2.0
+  - 1.9.3
+  - jruby
+  - rbx-2
+addons:
+  code_climate:
+    repo_token: c89e613dddb046253964e38324882d2e18082b23446e0ec944d5cfc761f97ad4

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in classy_plivo.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Faraz Yashar
+
+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,63 @@
+# ClassyPlivo :phone:
+
+[![Gem Version](https://badge.fury.io/rb/classy_plivo.svg)](http://badge.fury.io/rb/classy_plivo)
+[![Build Status](https://travis-ci.org/fny/classy_plivo.svg?branch=master)](https://travis-ci.org/fny/classy_plivo)
+[![Test Coverage](https://codeclimate.com/github/fny/classy_plivo/badges/coverage.svg)](https://codeclimate.com/github/fny/classy_plivo)
+[![Code Climate](https://codeclimate.com/github/fny/classy_plivo/badges/gpa.svg)](https://codeclimate.com/github/fny/classy_plivo)
+[![Dependency Status](https://gemnasium.com/fny/classy_plivo.svg)](https://gemnasium.com/fny/classy_plivo)
+
+A classy and minimalistic wrapper for the [Plivo Ruby library](https://github.com/plivo/plivo-ruby).
+
+## Overview
+
+```ruby
+# This matches Plivo::RestAPI signature
+classy_api = ClassyPlivo::RestAPI.new('auth_id', 'auth_token')
+classy_response = classy_api.get_account
+
+# => ClassyPlivo::Response
+classy_response.nonsense
+# => NoMethodError
+classy_response.error?
+# => true for 4XX and 5XX errors
+classy_response.http_status
+# => Integer response code
+classy_response.payload
+# => Twilio payload hash: { api_id: '1', 'message' => 'success' }
+classy_response.payload_key
+# => Value of payload['payload_key'] or ClassyPlivo::Response:::NoPayloadKeyError
+classy_response.has_payload_key?('whatever')
+# => true if the payload provides the requested key
+```
+
+A lot of this behavior relies on overriding `#method_missing`. For more details, check out the tests in the `test` directory and the source code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'classy_plivo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install classy_plivo
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec rake test` to run the test suite.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/fny/classy_plivo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'classy_plivo'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/classy_plivo.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'classy_plivo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'classy_plivo'
+  spec.version       = ClassyPlivo::VERSION
+  spec.authors       = ['Faraz Yashar']
+  spec.email         = ['faraz.yashar@gmail.com']
+
+  spec.summary       = 'A classy wrapper for the Plivo Ruby library'
+  spec.description   = 'A minimalistic and classy wrapper for the Plivo Ruby library.'
+  spec.homepage      = 'https://github.com/fny/classy_plivo'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'plivo', '~> 0.3.16'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'minitest', '~> 5.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/classy_plivo/response.rb

@@ -0,0 +1,34 @@
+module ClassyPlivo
+  class Response
+    attr_reader :http_status, :payload
+
+    # Raised when attempting to access a key that does not exist in Plivo's
+    # response payload
+    NoPayloadKeyError = Class.new(NoMethodError)
+
+    def initialize(response)
+      @http_status = response[0]
+      @payload = response[1]
+    end
+
+    # True if 4XX or 5XX status code is received
+    def error?
+      http_status >= 400 && http_status <= 599
+    end
+
+    def has_payload_key?(key)
+      payload.has_key?(key)
+    end
+
+    # Delegate all other method calls to the payload hash
+    def method_missing(method, *args, &block)
+      payload_key = method.to_s
+      if has_payload_key?(payload_key)
+        payload[payload_key]
+      else
+        fail NoPayloadKeyError,
+          "Key '#{payload_key}' not found in response payload: #{payload}"
+      end
+    end
+  end
+end

data/lib/classy_plivo/rest_api.rb

@@ -0,0 +1,13 @@
+module ClassyPlivo
+  class RestAPI
+    attr_reader :plivo_api
+
+    def initialize(*args)
+      @plivo_api = Plivo::RestAPI.new(*args)
+    end
+
+    def method_missing(method, *args, &block)
+      Response.new(plivo_api.send(method, args, &block))
+    end
+  end
+end

data/lib/classy_plivo/version.rb

@@ -0,0 +1,3 @@
+module ClassyPlivo
+  VERSION = '0.1.0'
+end

data/lib/classy_plivo.rb

@@ -0,0 +1,8 @@
+require 'plivo'
+
+require 'classy_plivo/version'
+require 'classy_plivo/rest_api'
+require 'classy_plivo/response'
+
+module ClassyPlivo
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: classy_plivo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Faraz Yashar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plivo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !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'
+description: A minimalistic and classy wrapper for the Plivo Ruby library.
+email:
+- faraz.yashar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- classy_plivo.gemspec
+- lib/classy_plivo.rb
+- lib/classy_plivo/response.rb
+- lib/classy_plivo/rest_api.rb
+- lib/classy_plivo/version.rb
+homepage: https://github.com/fny/classy_plivo
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A classy wrapper for the Plivo Ruby library
+test_files: []