vibe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3a618d2547d2ba134182f8af9d83961e3bec85f
+  data.tar.gz: e183c7107daa1c0254b547029b59fcb6180a6465
+SHA512:
+  metadata.gz: 292c62a9feff52f505a9703721c26d0e5d8ec988e98d150e2e3d576cb90ddc0ff3b5f680adf3052c75d142675c375b7c1d3d20f021b9946469e4d74ed5336985
+  data.tar.gz: 7cfa1dbd417c5dcd9510433ccf835703b5225635df969627055d9b58fbba67c79ac6db602897fd0e0901baa467b92d603d2ef8c214e6a16af1b920b578307018

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vibe.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    vibe (0.0.1)
+      rest-client (~> 1.7.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mime-types (2.4.2)
+    netrc (0.8.0)
+    rake (10.1.0)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  vibe!

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Amal Francis
+
+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,13 @@
+Vibe API
+========
+
+A Ruby wrapper for the Vibe REST API.
+
+UNDER MIT LICENSE
+=================
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r vibe.rb"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << "-rubygems"
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/vibe.rb

@@ -0,0 +1,14 @@
+%w{version error configuration client}.each do |local|
+  require "vibe/#{local}"
+end
+
+module Vibe
+  extend Configuration
+
+  # Alias for Vibe::Client.new
+  #
+  # @return [Vibe::Client]
+  def self.new(options = { }, &block)
+    @api_client = Vibe::Client.new(options, &block)
+  end
+end

data/lib/vibe/client.rb

@@ -0,0 +1,31 @@
+require 'vibe/request'
+
+module Vibe
+  class Client
+
+    include Request
+
+    attr_accessor   *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options={}, &block)
+      # Merge the config values from the module and those passed
+      # to the client.
+      merged_options = Vibe.options.merge(options)
+
+      # Copy the merged values and ignore those
+      # not part of our configuration
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key]) if Configuration::VALID_OPTIONS_KEYS.include? key
+        send("#{key}=", Vibe.options[key]) if Configuration::VALID_CONNECTION_KEYS.include? key
+      end
+
+      self.instance_eval(&block) if block_given?
+    end
+
+    # Get Data from an Email
+    def get_data(email)
+      get_request '/initial_data', :email => email
+    end
+
+  end # Client
+end

data/lib/vibe/configuration.rb

@@ -0,0 +1,49 @@
+module Vibe
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent, :method, :format].freeze
+    VALID_OPTIONS_KEYS    = [:api_key].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+ 
+    DEFAULT_ENDPOINT    = 'https://vibeapp.co/api/v1/'.freeze
+    DEFAULT_METHOD      = :get.freeze
+    DEFAULT_USER_AGENT  = "Vibe API Ruby Gem #{Vibe::VERSION}".freeze
+ 
+    DEFAULT_API_KEY      = nil
+    DEFAULT_FORMAT       = :json.freeze
+ 
+    # Build accessor methods for every config options so we can do this
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+ 
+    def initialize
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.method     = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+      self.format     = DEFAULT_FORMAT
+    end
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+ 
+    # Setup Configuration
+    def configure
+      yield self
+    end
+
+    def reset
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.method     = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+      self.format     = DEFAULT_FORMAT
+
+      self.api_key    = DEFAULT_API_KEY
+    end
+ 
+    # Return the configuration values set in this module
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+
+  end # Configuration
+end

data/lib/vibe/error.rb

@@ -0,0 +1,29 @@
+module Vibe
+  module Error
+    class VibeError < StandardError
+      attr_reader :response_message, :response_headers
+
+      def initialize(message)
+        super(message)
+        @response_message = message
+      end
+    end
+  end # Error
+end
+
+%w[
+  service_error
+  not_found
+  forbidden
+  bad_request
+  unauthorized
+  service_unavailable
+  internal_server_error
+  unprocessable_entity
+  client_error
+  invalid_options
+  required_params
+  unknown_value
+].each do |error|
+  require "vibe/error/#{error}"
+end

data/lib/vibe/error/bad_request.rb

@@ -0,0 +1,10 @@
+module Vibe
+  module Error
+    # Raised when Vibe returns the HTTP status code 400
+    class BadRequest < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end
+end

data/lib/vibe/error/client_error.rb

@@ -0,0 +1,18 @@
+module Vibe
+  # Raised when Vibe returns the HTTP status code 404
+  module Error
+    class ClientError < VibeError
+      attr_reader :problem, :summary, :resolution
+
+      def initialize(message)
+        super(message)
+      end
+
+      def generate_message(attributes)
+        "\nProblem:\n #{attributes[:problem]}"+
+        "\nSummary:\n #{attributes[:summary]}"+
+        "\nResolution:\n #{attributes[:resolution]}"
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/forbidden.rb

@@ -0,0 +1,10 @@
+module Vibe
+  # Raised when Vibe returns the HTTP status code 403
+  module Error
+    class Forbidden < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/internal_server_error.rb

@@ -0,0 +1,10 @@
+module Vibe
+  # Raised when Vibe returns the HTTP status code 500
+  module Error
+    class InternalServerError < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/invalid_options.rb

@@ -0,0 +1,16 @@
+module Vibe
+  # Raised when invalid options are passed to a request body
+  module Error
+    class InvalidOptions < ClientError
+      def initialize(invalid, valid)
+        super(
+          generate_message(
+            :problem => "Invalid option #{invalid.keys.join(', ')} provided for this request.", 
+            :summary => "Vibe gem checks the request parameters passed to ensure that Vibe api is not hit unnecessairly and to fail fast.",
+            :resolution => "Valid options are: #{valid.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/not_found.rb

@@ -0,0 +1,10 @@
+module Vibe
+  # Raised when Vibe returns the HTTP status code 404
+  module Error
+    class NotFound < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/required_params.rb

@@ -0,0 +1,16 @@
+module Vibe
+  # Raised when invalid options are passed to a request body
+  module Error
+    class RequiredParams < ClientError
+      def initialize(provided, required)
+        super(
+          generate_message(
+            :problem => "Missing required parameters: #{provided.keys.join(', ')} provided for this request.",
+            :summary => "Vibe gem checks the request parameters passed to ensure that Vibe api is not hit unnecessairly and to fail fast.",
+            :resolution => "Required parameters are: #{required.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/service_error.rb

@@ -0,0 +1,21 @@
+module Vibe
+  # Raised when Vibe returns any of the HTTP status codes
+  module Error
+    class ServiceError < VibeError
+      attr_accessor :http_headers
+
+      def initialize(env)
+        super(generate_message(env))
+        @http_headers = env[:response_headers]
+      end
+
+      def generate_message(env)
+        if ENV['DEBUG']
+          "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]} #{env[:body]}"
+        else
+          env[:body]
+        end
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/service_unavailable.rb

@@ -0,0 +1,10 @@
+module Vibe
+  # Raised when Vibe returns the HTTP status code 503
+  module Error
+    class ServiceUnavailable < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/unauthorized.rb

@@ -0,0 +1,10 @@
+module Vibe
+  # Raised when Vibe returns the HTTP status code 401
+  module Error
+    class Unauthorized < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/unknown_value.rb

@@ -0,0 +1,16 @@
+module Vibe
+  # Raised when invalid options are passed to a request body
+  module Error
+    class UnknownValue < ClientError
+      def initialize(key, value, permitted)
+        super(
+          generate_message(
+            :problem => "Wrong value of '#{value}' for the parameter: #{key} provided for this request.",
+            :summary => "Vibe gem checks the request parameters passed to ensure that Vibe api is not hit unnecessairly and fails fast.",
+            :resolution => "Permitted values are: #{permitted}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/unprocessable_entity.rb

@@ -0,0 +1,10 @@
+module Vibe
+  # Raised when Vibe returns the HTTP status code 422
+  module Error
+    class UnprocessableEntity < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end

data/lib/vibe/error/validations.rb

@@ -0,0 +1,16 @@
+module Vibe
+  # Raised when passed parameters are missing or contain wrong values.
+  module Error
+    class Validations < ClientError
+      def initialize(errors)
+        super(
+          generate_message(
+            :problem => '',
+            :summary => '',
+            :resolution => ''
+          )
+        )
+      end
+    end
+  end # Error
+end

data/lib/vibe/request.rb

@@ -0,0 +1,56 @@
+require 'rest_client'
+
+module Vibe
+  module Request
+
+    extend Configuration
+    include Error
+
+    METHODS = [:get, :post, :put, :delete, :patch]
+
+    def get_request(path, params={})
+      request(:get, path, params)
+    end
+
+    def request(method, path, params)
+      if !METHODS.include?(method)
+	raise ArgumentError, "unkown http method: #{method}"
+      end
+
+      if !api_key
+        raise ClientError, 'API key need to be set' 
+      end
+
+      puts "EXECUTED: #{method} - #{path} with #{params}" if ENV['DEBUG']
+
+      params.merge!({:api_key => api_key, :user_agent => user_agent})
+
+      begin
+        puts params if ENV['DEBUG']
+        response = RestClient.send("#{method}", endpoint + path.gsub!(/^\//, ""), :params => params){ |response, request, result, &block|
+          if [301, 302, 307].include? response.code
+            response.follow_redirection(request, result, &block)
+          elsif !response.code.between?(200, 400)
+              if response.code == 401
+                resp = JSON.parse(response.body)
+                raise Unauthorized, {:status => response.code, :method => method, :response_headers => response.headers, :url => endpoint + path, :body => resp['status']}
+              elsif response.code == 403
+                resp = JSON.parse(response.body)
+                raise Forbidden, {:status => response.code, :method => method, :response_headers => response.headers, :url => endpoint + path, :body => resp['status']}
+              elsif response.code == 422
+                resp = JSON.parse(response.body)
+                raise UnprocessableEntity, {:status => response.code, :method => method, :response_headers => response.headers, :url => endpoint + path, :body => resp['status']}
+              else
+                raise ServiceError, {:status => response.code, :method => method, :response_headers => response.headers, :url => endpoint + path, :body => "API Returned status code #{response.code}"}
+              end
+          else
+            JSON.parse(response)
+          end
+        }
+      rescue SocketError => e
+        raise VibeError, 'xgcv'
+      end
+
+    end
+  end # Request
+end

data/lib/vibe/version.rb

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

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'vibe'
+require 'minitest/spec'
+require 'minitest/autorun'

data/test/vibe/client_test.rb

@@ -0,0 +1,48 @@
+require 'helper'
+
+describe 'client' do
+
+  before do
+    @keys = Vibe::Configuration::VALID_CONFIG_KEYS
+  end
+
+  describe 'with module configuration' do
+    before do
+      Vibe.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Vibe.reset
+    end
+
+    it "should inherit module configuration" do
+      api = Vibe::Client.new
+      @keys.each do |key|
+        api.send(key).must_equal key
+      end
+    end
+
+    describe 'with class configuration' do
+      before do
+        @config = {
+          :api_key    => 'ak'
+        }
+      end
+
+      it 'should override module configuration after' do
+        api = Vibe::Client.new
+
+        @config.each do |key, value|
+          api.send("#{key}=", value)
+        end
+      end
+
+    end
+
+  end
+
+end

data/test/vibe/configuration_test.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+describe 'configuration' do
+ 
+  describe '.api_key' do
+    it 'should return default key' do
+      Vibe.api_key.must_equal Vibe::Configuration::DEFAULT_API_KEY
+    end
+  end
+
+  describe '.user_agent' do
+    it 'should return default user agent' do
+      Vibe.user_agent.must_equal Vibe::Configuration::DEFAULT_USER_AGENT
+    end
+  end
+ 
+  describe '.method' do
+    it 'should return default http method' do
+      Vibe.method.must_equal Vibe::Configuration::DEFAULT_METHOD
+    end
+  end
+ 
+  after do
+    Vibe.reset
+  end
+
+  describe '.configure' do
+    Vibe::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "should set the #{key}" do
+        Vibe.configure do |config|
+          config.send("#{key}=", key)
+          Vibe.send(key).must_equal key
+        end
+      end
+    end
+  end
+
+  Vibe::Configuration::VALID_CONFIG_KEYS.each do |key|
+    describe ".#{key}" do
+      it 'should return the default value' do
+        Vibe.send(key).must_equal Vibe::Configuration.const_get("DEFAULT_#{key.upcase}")
+      end
+    end
+  end
+end

data/test/vibe/vibe_test.rb

@@ -0,0 +1,7 @@
+require 'helper'
+ 
+describe Vibe do
+  it 'should have a version' do
+    Vibe::VERSION.wont_be_nil
+  end
+end

data/vibe.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vibe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vibe"
+  spec.version       = Vibe::VERSION
+  spec.authors       = ["Amal Francis"]
+  spec.email         = ["amalfra@gmail.com"]
+  spec.summary       = %q{A Ruby wrapper for the Vibe REST API}
+  spec.description   = %q{A Ruby wrapper for the Vibe REST API}
+  spec.homepage      = "https://github.com/amalfra/vibe"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 1.7"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: vibe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Amal Francis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 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 Ruby wrapper for the Vibe REST API
+email:
+- amalfra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/vibe.rb
+- lib/vibe/client.rb
+- lib/vibe/configuration.rb
+- lib/vibe/error.rb
+- lib/vibe/error/bad_request.rb
+- lib/vibe/error/client_error.rb
+- lib/vibe/error/forbidden.rb
+- lib/vibe/error/internal_server_error.rb
+- lib/vibe/error/invalid_options.rb
+- lib/vibe/error/not_found.rb
+- lib/vibe/error/required_params.rb
+- lib/vibe/error/service_error.rb
+- lib/vibe/error/service_unavailable.rb
+- lib/vibe/error/unauthorized.rb
+- lib/vibe/error/unknown_value.rb
+- lib/vibe/error/unprocessable_entity.rb
+- lib/vibe/error/validations.rb
+- lib/vibe/request.rb
+- lib/vibe/version.rb
+- test/helper.rb
+- test/vibe/client_test.rb
+- test/vibe/configuration_test.rb
+- test/vibe/vibe_test.rb
+- vibe.gemspec
+homepage: https://github.com/amalfra/vibe
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Vibe REST API
+test_files:
+- test/helper.rb
+- test/vibe/client_test.rb
+- test/vibe/configuration_test.rb
+- test/vibe/vibe_test.rb