taxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9d6569b4dfbecbf0a774d58511350ad449775f6
+  data.tar.gz: e901392a84e9ff48d429ba078c4de46ad6fdb88b
+SHA512:
+  metadata.gz: 3951976f596410b2d6543854d81aebcf2f1d76923c976cc36b7c1d1b0b9cf0f752f3707289be0de9fab961997981953bf23cc73098a48b36f396e28517cc3167
+  data.tar.gz: 6406ff3af3b5d9fbbec61fa1e7936792b746c3e80066d1c55563ebd887ac858b94e18c007ea1a9085fdfcd2efc9045a595e96a11485f2df63bb03bbb3774ab3a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rafael Gibim
+
+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 @@
+# Taxy
+
+Simple API wrapper for Cabify public API, built on top of Faraday.
+As of now, a bearer token is required beforehand
+
+## Installation
+
+Add this line to your application's Gemfile, then execute `bundle`:
+
+```ruby
+gem 'taxy'
+```
+
+Or install it yourself as:
+
+    $ gem install taxy
+
+## Usage
+
+```ruby
+Taxy::Client.new(bearer_token: 123)
+=> #<Taxy::Client:0x00000001ebe280 @bearer_token=123>
+```
+
+```ruby
+taxy = Taxy::Client.new(bearer_token: 123)
+taxy.user # http://developers.cabify.com/#users
+=> #<Taxy::User:0x00000001a31500
+ @avatar_url="http://example.com/example.jpg",
+ @email="johndoe@example.com",
+ @locale="pt-BR",
+ @mobile_cc="12",
+ @mobile_num="123123123",
+ @name="John",
+ @surname="Doe">
+```
+
+```ruby
+taxy = Taxy::Client.new(bearer_token: 123) # http://developers.cabify.com/#estimates
+taxy.estimate(starting_latitude: 1, starting_longitude: 1, ending_latitude: 1, ending_longitude: 1)
+=> [#<Taxy::Estimation:0x00000002053eb0
+  @currency="EUR",
+  @currency_symbol="€",
+  @price_formatted="12.34€",
+  @total_price=1234,
+  @vehicle_type=
+   #<Taxy::Estimation::Vehicle:0x00000002053de8
+    @_id="executive_id",
+    @description="A very large vehicle with comfortable seats",
+    @eta=#<Taxy::Estimation::Vehicle::Eta:0x00000002053780 @formatted=">2 min", @low_availability=nil, @max=1000, @min=100>,
+    @icon="executive",
+    @icons=#<Taxy::Estimation::Vehicle::Icons:0x00000002053988 @regular="https://cabify.com/images/icons/vehicle_type/executive_27.png">,
+    @name="Executive Class",
+    @short_name="Executive">>]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Drowze/taxy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/client.rb

@@ -0,0 +1,23 @@
+require 'virtus'
+
+require 'connection'
+require 'client/estimate'
+require 'client/user'
+
+require 'models/estimation'
+
+module Taxy
+  class Client
+    include Taxy::Connection
+    include Taxy::Client::Estimate
+    include Taxy::Client::User
+
+    attr_accessor :bearer_token, :debug
+
+    def initialize(options = {})
+      options.each do |key, value|
+        send(:"#{key}=", value)
+      end
+    end
+  end
+end

data/lib/client/estimate.rb

@@ -0,0 +1,27 @@
+require 'models/estimation'
+
+module Taxy
+  class Client
+    module Estimate
+      def estimate(starting_latitude:, starting_longitude:,
+        ending_latitude:, ending_longitude:)
+
+        params = build_params([starting_latitude, starting_longitude], [ending_latitude, ending_longitude])
+
+        response = post('/api/v2/estimate', params)
+        response.map { |est| Taxy::Estimation.new(est) } if @last_response.success?
+      end
+
+      private
+
+      def build_params(starting_point, ending_point)
+        {
+          stops: [
+            { loc: starting_point },
+            { loc: ending_point }
+          ]
+        }
+      end
+    end
+  end
+end

data/lib/client/user.rb

@@ -0,0 +1,12 @@
+require 'models/user'
+
+module Taxy
+  class Client
+    module User
+      def user(params = {})
+        response = get('/api/v2/user', params)
+        Taxy::User.new(response) if @last_response.success?
+      end
+    end
+  end
+end

data/lib/connection.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'faraday'
+require 'response/parse_json'
+
+module Taxy
+  module Connection
+    BASE_URI = 'https://test.cabify.com'.freeze
+
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def post(path, params = {})
+      request(:post, path, params.to_json)
+    end
+
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    def put(path, params = {})
+      request(:put, path, params.to_json)
+    end
+
+    def patch(path, params = {})
+      request(:patch, path, params.to_json)
+    end
+
+    private
+
+    def request(method, path, params = {})
+      @last_response = agent.send(method.to_sym, path, params)
+      @last_response.body
+    end
+
+    def agent
+      @agent ||= Faraday.new(BASE_URI, connection_options) do |http|
+        http.headers[:content_type] = 'application/json'.freeze
+        http.headers[:user_agent] = 'Cabify API Ruby Wrapper'.freeze
+        http.headers[:accept_language] = 'en'.freeze
+        http.authorization 'Bearer', @bearer_token if @bearer_token
+      end
+    end
+
+    def connection_options
+      @connection_options ||= {
+        builder: middleware,
+        request: {
+          open_timeout: 10,
+          timeout: 30
+        }
+      }
+    end
+
+    def middleware
+      @middleware ||= Faraday::RackBuilder.new do |faraday|
+        faraday.response :parse_json
+        faraday.response :logger if debug.to_s.casecmp('true').zero?
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/models/estimation.rb

@@ -0,0 +1,13 @@
+require 'models/estimation/vehicle'
+
+module Taxy
+  class Estimation
+    include Virtus.model
+
+    attribute :vehicle_type, Vehicle
+    attribute :total_price, Integer
+    attribute :currency, String
+    attribute :currency_symbol, String
+    attribute :price_formatted, String
+  end
+end

data/lib/models/estimation/vehicle.rb

@@ -0,0 +1,18 @@
+require 'models/estimation/vehicle/icons'
+require 'models/estimation/vehicle/eta'
+
+module Taxy
+  class Estimation
+    class Vehicle
+      include Virtus.model
+
+      attribute :_id, String
+      attribute :name, String
+      attribute :short_name, String
+      attribute :description, String
+      attribute :icon, String
+      attribute :icons, Icons
+      attribute :eta, Eta
+    end
+  end
+end

data/lib/models/estimation/vehicle/eta.rb

@@ -0,0 +1,14 @@
+module Taxy
+  class Estimation
+    class Vehicle
+      class Eta
+        include Virtus.model
+
+        attribute :min, Integer
+        attribute :max, Integer
+        attribute :low_availability, Boolean
+        attribute :formatted, String
+      end
+    end
+  end
+end

data/lib/models/estimation/vehicle/icons.rb

@@ -0,0 +1,11 @@
+module Taxy
+  class Estimation
+    class Vehicle
+      class Icons
+        include Virtus.model
+
+        attribute :regular, String
+      end
+    end
+  end
+end

data/lib/models/user.rb

@@ -0,0 +1,13 @@
+module Taxy
+  class User
+    include Virtus.model
+
+    attribute :avatar_url, String
+    attribute :name, String
+    attribute :surname, String
+    attribute :email, String
+    attribute :mobile_cc, String
+    attribute :mobile_num, String
+    attribute :locale, String
+  end
+end

data/lib/response/parse_json.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'json'
+
+module Taxy
+  module Response
+    class ParseJson < Faraday::Response::Middleware
+      WHITESPACE_REGEX = /\A^\s*$\z/
+
+      def parse(body)
+        case body
+        when WHITESPACE_REGEX, nil
+          nil
+        else
+          JSON.parse(body, symbolize_names: true)
+        end
+      end
+
+      def on_complete(response)
+        return if unparsable_status_codes.include?(response.status)
+        response.body = parse(response.body) if respond_to?(:parse)
+      end
+
+      def unparsable_status_codes
+        [204, 301, 302, 304]
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware parse_json: Taxy::Response::ParseJson

data/lib/taxy.rb

@@ -0,0 +1 @@
+require 'client'

data/spec/client/estimate_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'pry'
+
+describe Taxy::Client::Estimate do
+  let(:client) { Taxy::Client.new(bearer_token: 'CABIFY_BEARER_TOKEN') }
+  subject { client.estimate(starting_latitude: 1, starting_longitude: 2, ending_latitude: 3, ending_longitude: 4) }
+
+  describe '#user' do
+    context 'when the request is successful' do
+      let(:request_params_hash) {
+        { stops: [{ loc: [1, 2] }, { loc: [3, 4] }] }
+      }
+      let(:response_hash) do
+        [
+          {
+            vehicle_type: {
+              _id: 'executive_id',
+              name: 'Executive Class',
+              short_name: 'Executive',
+              description: 'A very large vehicle with comfortable seats',
+              icon: 'executive',
+              icons: {
+                regular: 'https://cabify.com/images/icons/vehicle_type/executive_27.png'
+              },
+              eta: {
+                min: 100,
+                max: 1000,
+                formatted: '>2 min'
+              }
+            },
+            total_price: 1234,
+            price_formatted: '12.34€',
+            currency: 'EUR',
+            currency_symbol: '€',
+          }
+        ]
+      end
+
+      before do
+        stub_cabify_request(
+          verb: :post,
+          params: request_params_hash,
+          endpoint: '/api/v2/estimate',
+          status: 200,
+          response: response_hash
+        )
+      end
+
+      it 'returns an array of Taxy::Estimation instance' do
+        expect(subject.first.class).to eq Taxy::Estimation
+        expect(subject.first.vehicle_type.class).to eq Taxy::Estimation::Vehicle
+        expect(subject.first.vehicle_type.icons.class).to eq Taxy::Estimation::Vehicle::Icons
+        expect(subject.first.vehicle_type.eta.class).to eq Taxy::Estimation::Vehicle::Eta
+      end
+
+      it 'returns estimations' do
+        expect(subject.first).to have_attributes({
+          total_price: 1234,
+          price_formatted: '12.34€',
+          currency: 'EUR',
+          currency_symbol: '€',
+        })
+        expect(subject.first.vehicle_type).to have_attributes({
+          _id: 'executive_id',
+          name: 'Executive Class',
+          short_name: 'Executive',
+          description: 'A very large vehicle with comfortable seats',
+          icon: 'executive',
+        })
+        expect(subject.first.vehicle_type.icons).to have_attributes({
+          regular: 'https://cabify.com/images/icons/vehicle_type/executive_27.png'
+        })
+        expect(subject.first.vehicle_type.eta).to have_attributes({
+          min: 100,
+          max: 1000,
+          formatted: '>2 min'
+        })
+      end
+    end
+  end
+end

data/spec/client/user_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Taxy::Client::User do
+  let(:client) { Taxy::Client.new(bearer_token: 'CABIFY_BEARER_TOKEN') }
+
+  describe '#user' do
+    context 'when the request is successful' do
+      let(:response_hash) do
+        {
+          name: 'John',
+          surname: 'Doe',
+          email: 'johndoe@example.com',
+          mobile_cc: '12',
+          mobile_num: '123123123',
+          locale: 'pt-BR',
+          avatar_url: 'http://example.com/example.jpg'
+        }
+      end
+
+      before do
+        stub_cabify_request(verb: :get, endpoint: '/api/v2/user', status: 200, response: response_hash)
+      end
+
+      it 'returns a Taxy::User instance' do
+        expect(client.user.class).to eq Taxy::User
+      end
+
+      it 'returns the current user' do
+        expect(client.user).to have_attributes({
+          name: 'John',
+          surname: 'Doe',
+          email: 'johndoe@example.com',
+          mobile_cc: '12',
+          mobile_num: '123123123',
+          locale: 'pt-BR',
+          avatar_url: 'http://example.com/example.jpg'
+        })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require 'taxy'
+require 'webmock/rspec'
+
+Dir[File.join(File.dirname(__FILE__), './support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |c|
+  c.include HttpMockHelpers
+
+  c.before :all do
+    WebMock.disable_net_connect!(allow_localhost: true)
+  end
+end

data/spec/support/http_mock_helpers.rb

@@ -0,0 +1,16 @@
+module HttpMockHelpers
+  def stub_cabify_request(verb:, endpoint:, params: nil, response: nil, status: nil)
+    options = Hash.new.tap do |h|
+      h[:headers] = {
+        'Authorization' => 'Bearer CABIFY_BEARER_TOKEN',
+        'Content-Type'=>'application/json',
+        'User-Agent'=>'Cabify API Ruby Wrapper'
+      }
+      h[:body] = params.to_json unless params.nil?
+    end
+
+    stub_request(verb, "#{Taxy::Connection::BASE_URI}#{endpoint}")
+      .with(options)
+      .to_return(status: status || 200, body: response ? response.to_json : '')
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: taxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafael G
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- gibim6+taxy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/client.rb
+- lib/client/estimate.rb
+- lib/client/user.rb
+- lib/connection.rb
+- lib/models/estimation.rb
+- lib/models/estimation/vehicle.rb
+- lib/models/estimation/vehicle/eta.rb
+- lib/models/estimation/vehicle/icons.rb
+- lib/models/user.rb
+- lib/response/parse_json.rb
+- lib/taxy.rb
+- spec/client/estimate_spec.rb
+- spec/client/user_spec.rb
+- spec/spec_helper.rb
+- spec/support/http_mock_helpers.rb
+- spec/taxy_spec.rb
+homepage: https://github.com/drowze/taxy
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Cabify API wrapper.
+test_files: []