london_cab 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d9e0d267201dedee13c90e915a83be291835d39
+  data.tar.gz: c272bc19d38e2465d78a9b74b621338508c8ea5e
+SHA512:
+  metadata.gz: c7e9e2cb76dd0ef7b9322e3a520aad715317794dce7a1b95de8f6c1cd952d3aaa83e8d2da92315f7ff08bf2c9069faea4b254dbc9d07584dfd5ca8788c3f4027
+  data.tar.gz: 7b748fc18fdbc833f2b657de37d842539d9814a23f4c5a348f8cc089a3252d43d7f0dce222091f1355f5f31ba58e551a448d11c63267582026c12d59c0b731cf

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Lint/HandleExceptions:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,100 @@
+# LondonCab
+
+[![Gem Version](https://badge.fury.io/rb/london_cab.svg)](http://badge.fury.io/rb/london_cab)
+[![Build Status](https://travis-ci.org/RaMin0/london_cab.svg?branch=master)](https://travis-ci.org/RaMin0/london_cab)
+[![Code Climate](https://codeclimate.com/github/RaMin0/london_cab/badges/gpa.svg)](https://codeclimate.com/github/RaMin0/london_cab)
+
+A Ruby client for the [London Cab](http://65.182.108.16) APIs.
+
+[![](london_cab.png)](http://65.182.108.16)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'london_cab'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install london_cab
+```
+
+## Usage
+
+### API Token
+To acquire an API token, use the [london_cab-auth](https://github.com/RaMin0/london_cab-auth) gem. Use the same credentials for your corporate London Cab account.
+
+### Configuration
+
+```ruby
+LondonCab.configure do |config|
+  config.token = ENV['LONDON_CAB_API_TOKEN']
+end
+```
+
+This sets a global default token. You can also pass a token to the initializer of `LondonCab::Client`.
+
+```ruby
+client = LondonCab::Client.new(token: ENV['LONDON_CAB_API_TOKEN'])
+```
+
+The instance token will be used over the global default.
+
+The following globals settings are supported via `LondonCab.configure`.
+
+setting      | description
+-------------|------------
+token        | London Cab API token.
+logger       | An optional logger.<br/>**Default:** `Logger.new(STDOUT)` at `Logger::WARN` level.
+
+### Client
+
+The London Cab API allows you to build applications that interact with London Cab.
+
+#### Configuration
+setting      | description
+-------------|------------
+endpoint     | London Cab endpoint.<br/>**Default:** http://65.182.108.16:3467/api
+user_agent   | User-agent.<br/>**Default:** LondonCab/VERSION.
+token        | **Required.** London Cab API token.
+logger       | **Optional.** `Logger` instance that logs HTTP requests.
+
+## Documentation
+
+### Rides
+You can use the client to make requests related to rides.
+
+#### Request Rides
+
+Request rides with `#ride_request`.
+
+```ruby
+client.ride_request(PickupLong:  '31.276942',
+                    PickupLat:   '29.962696',
+                    DropoffLong: '31.330108',
+                    DropoffLat:  '30.056610')
+```
+
+## History
+
+The structure of this gem is based on [slack-ruby-gem](https://github.com/slack-ruby/slack-ruby-client).
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/RaMin0/london_cab]().
+

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 'london_cab'
+
+# 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/london_cab/api/endpoints/ride.rb

@@ -0,0 +1,11 @@
+module LondonCab
+  module Api
+    module Endpoints
+      module Ride
+        def ride_request(options = {})
+          post('RequestRide', options)
+        end
+      end
+    end
+  end
+end

data/lib/london_cab/api/endpoints.rb

@@ -0,0 +1,9 @@
+require 'london_cab/api/endpoints/ride'
+
+module LondonCab
+  module Api
+    module Endpoints
+      include Ride
+    end
+  end
+end

data/lib/london_cab/api/error.rb

@@ -0,0 +1,12 @@
+module LondonCab
+  module Api
+    class Error < ::Faraday::Error
+      attr_reader :response
+
+      def initialize(message, response = nil)
+        @response = response
+        super(message)
+      end
+    end
+  end
+end

data/lib/london_cab/client.rb

@@ -0,0 +1,27 @@
+module LondonCab
+  class Client
+    include Faraday::Connection
+    include Faraday::Request
+    include Api::Endpoints
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def initialize(options = {})
+      LondonCab::Config::ATTRIBUTES.each do |key|
+        send("#{key}=", options[key] || LondonCab.config.send(key))
+      end
+
+      @logger ||= LondonCab::Config.logger || LondonCab::Logger.default
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end

data/lib/london_cab/config.rb

@@ -0,0 +1,33 @@
+module LondonCab
+  module Config
+    extend self
+
+    ATTRIBUTES = [
+      :endpoint,
+      :user_agent,
+      :token,
+      :logger
+    ].freeze
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def reset
+      self.endpoint   = 'http://65.182.108.16:3467/api/CorporateAPI'
+      self.user_agent = "LondonCab/#{LondonCab::VERSION}"
+      self.token      = nil
+      self.logger     = nil
+    end
+
+    reset
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/london_cab/faraday/connection.rb

@@ -0,0 +1,29 @@
+module LondonCab
+  module Faraday
+    module Connection
+      private
+
+      def connection
+        options = {
+          headers: {
+            'Accept'       => 'application/json; charset=utf-8',
+            'Content-Type' => 'application/json'
+          }
+        }
+
+        options[:headers]['Authorization'] = "Bearer #{token}" if token
+        options[:headers]['User-Agent']    = user_agent        if user_agent
+
+        ::Faraday::Connection.new(endpoint, options) do |connection|
+          connection.use ::FaradayMiddleware::EncodeJson
+          connection.use ::LondonCab::Faraday::Response::RaiseError
+          connection.use ::FaradayMiddleware::ParseJson
+          connection.use ::Faraday::Response::RaiseError
+
+          connection.response :logger, logger if logger
+          connection.adapter ::Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/london_cab/faraday/request.rb

@@ -0,0 +1,37 @@
+module LondonCab
+  module Faraday
+    module Request
+      def get(path, options = {})
+        request(:get, path, options)
+      end
+
+      def post(path, options = {})
+        request(:post, path, options)
+      end
+
+      def put(path, options = {})
+        request(:put, path, options)
+      end
+
+      def delete(path, options = {})
+        request(:delete, path, options)
+      end
+
+      private
+
+      def request(method, path, options)
+        response = connection.send(method) do |request|
+          case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options unless options.empty?
+          end
+        end
+
+        response.body
+      end
+    end
+  end
+end

data/lib/london_cab/faraday/response/raise_error.rb

@@ -0,0 +1,14 @@
+module LondonCab
+  module Faraday
+    module Response
+      class RaiseError < ::Faraday::Response::Middleware
+        def on_complete(env)
+          body = env.body
+          return body['Result'] unless body['HasError']
+
+          raise LondonCab::Api::Error.new(body['Messgage'], env.response)
+        end
+      end
+    end
+  end
+end

data/lib/london_cab/logger.rb

@@ -0,0 +1,14 @@
+require 'logger'
+
+module LondonCab
+  class Logger < ::Logger
+    def self.default
+      @logger ||= begin
+        logger = new STDOUT
+        logger.progname = "LondonCab/#{VERSION}"
+        logger.level    = Logger::WARN
+        logger
+      end
+    end
+  end
+end

data/lib/london_cab/version.rb

@@ -0,0 +1,3 @@
+module LondonCab
+  VERSION = '0.1.1'.freeze
+end

data/lib/london_cab.rb

@@ -0,0 +1,21 @@
+begin
+  require 'byebug'
+rescue LoadError
+end
+
+require 'london_cab/version'
+require 'london_cab/logger'
+require 'london_cab/config'
+
+# API
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'logger'
+
+require 'london_cab/api/error'
+require 'london_cab/faraday/response/raise_error'
+require 'london_cab/faraday/connection'
+require 'london_cab/faraday/request'
+require 'london_cab/api/endpoints'
+require 'london_cab/client'

data/london_cab.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'london_cab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'london_cab'
+  spec.version       = LondonCab::VERSION
+  spec.authors       = ['Ramy Aboul Naga']
+  spec.email         = ['ramy.naga@gmail.com']
+
+  spec.summary       = 'LondonCab Client'
+  spec.homepage      = 'https://github.com/RaMin0/london_cab'
+
+  spec.files         = `git ls-files`.split("\n").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 0.9'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'byebug',  '~> 9.0'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47.1'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: london_cab
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ramy Aboul Naga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: json
+  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: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: 
+email:
+- ramy.naga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/london_cab.rb
+- lib/london_cab/api/endpoints.rb
+- lib/london_cab/api/endpoints/ride.rb
+- lib/london_cab/api/error.rb
+- lib/london_cab/client.rb
+- lib/london_cab/config.rb
+- lib/london_cab/faraday/connection.rb
+- lib/london_cab/faraday/request.rb
+- lib/london_cab/faraday/response/raise_error.rb
+- lib/london_cab/logger.rb
+- lib/london_cab/version.rb
+- london_cab.gemspec
+- london_cab.png
+homepage: https://github.com/RaMin0/london_cab
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: LondonCab Client
+test_files: []