beetrackapi 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 125410134eb77a70b91301f16624664f04979bcd
-  data.tar.gz: 4027c261db89866e93d2c4607900d8f9ae543626
+  metadata.gz: 5dd0cc4e8ab72482869613c6d057c1c3a3cc7191
+  data.tar.gz: 65c3c23bc93479e5deb39d5ff3a4a9623b4a93d4
 SHA512:
-  metadata.gz: 8c6030f903e96e8381847152ff90f18839622e134f356eee5ae69276736fe06fae7f5b38b7a05a6cb7f6db195d675eafa86afbef27ee25498fc39ca66a7815cd
-  data.tar.gz: 4c019f4457f42c980bf4bf1aa60fdd2c3447a5dfb2b37763a6014ae14d1be02de4cae80a63cc6d7d1759998a1cf1710d2b601690449eae13d30b558891916bf0
+  metadata.gz: f7fb6ad90c5d27492af7732b272c4bdcfdbd3d19f1ad6fb642a600629f3e3c998dab857506623dfa2d43cfcc993a7f8b36f90ade419903ba5506da8d96d763dd
+  data.tar.gz: 937945fede287e93ba1b5376d63dd326061a0e1ce964fa554241531bbc0b66b19e08b9faca879052900a88ea3197af92fcbf496ce2b7113ec65a0c3c58035f2d

data/README.md

@@ -20,20 +20,25 @@ client = BeetrackAPI::Client.new(:key => <your_api_key>)
 
 ###Get Routes###
 ```ruby
-client.getroutes(:date => 'dd-mm-yyyy'(Optional))
+client.get_routes(:date => 'dd-mm-yyyy'(Optional))
 ```
 
 ###Create Routes###
 ```ruby
-client.createroute(<route_id>, parameters (As seen in beetrack.in/external_api.html))
+client.create_route(<route_id>, parameters)
 ```
 
 ###Get Dispatch Information###
 ```ruby
-client.getdispatchinfo(<dispatch_id>)
+client.get_dispatch_info(<dispatch_id>)
 ```
 
 ###Update Route Information###
 ```ruby
-client.updateroute(route_id, parameters (As seen in beetrack.in/external_api.html)))
-```
+client.update_route(route_id, parameters)
+```
+
+
+## Documentation
+
+Please check the API's documentation in https://beetrack.com/apidoc

data/beetrackapi.gemspec

@@ -1,14 +1,13 @@
 Gem::Specification.new do |s|
   s.name = 'beetrackapi'
-  s.version = '0.5.0'
-  s.licenses = ['MIT']
+  s.version = '0.6.0'
   s.platform = Gem::Platform::RUBY
-  s.authors = ['Nicolás Kipreos']
-  s.email = ['nicolas.kipreos@beetrack.in']
-  s.homepage = 'http://github.com/nkipreos/'
+  s.authors = ['Nicolás Kipreos', 'Jose Luis Honorato']
+  s.email = ['nicolas.kipreos@beetrack.com']
+  s.homepage = 'https://github.com/Beetrack/beetrack-api-ruby'
   s.description = 'A Ruby Wrapper for the Beetrack API'
   s.summary = 'See description'
   s.files = Dir.glob('{lib}/**/*') + %w(README.md beetrackapi.gemspec)
-  s.add_development_dependency('curb', '>= 0.8.5')
+  s.add_development_dependency('rest-client', '>= 1.7.3')
   s.require_path = 'lib'
 end

data/lib/beetrackapi.rb

@@ -1,48 +1,66 @@
-require 'curb'
 require 'json'
 require 'cgi'
 require 'time'
 require 'rest_client'
 
 module BeetrackAPI
-    
+
     class Error < StandardError; end
     class AuthenticationError < Error; end
 
     class Client
         attr_accessor :key
-        attr_reader :url 
+        attr_reader :url
 
         def initialize(options = {})
             @key = options[:key]
             @url = options[:url] || 'https://app.beetrack.cl/api/external/v1/'
+            @url = @url + '/' if @url[-1] != '/'
         end
 
-        def getroutes(options = {})
+        def get_routes(options = {})
             date = options.empty? ? "#{Date.today.strftime("%d-%m-%Y")}" : options[:date]
             get('routes', :date => date)
         end
 
-        def getroute(route_id)
+        alias_method :getroutes, :get_routes
+
+        def get_route(route_id)
             get("routes/#{route_id}")
         end
 
-        def createroute(options = {})
+        alias_method :getroute, :get_route
+
+        def create_route(options = {})
             post("routes", options)
         end
 
-        def getdispatchinfo(dispatch_id)
+        alias_method :createroute, :create_route
+
+        def get_dispatch_info(dispatch_id)
             get("dispatches/#{dispatch_id}")
         end
 
-        def gettrucks
+        alias_method :getdispatchinfo, :get_dispatch_info
+
+        def get_trucks
             get("trucks")
         end
 
-        def updateroute(route_id, options ={})
+        alias_method :gettrucks, :get_trucks
+
+        def get_truck(identifier)
+            get("trucks/#{identifier}")
+        end
+
+        alias_method :gettruck, :get_truck
+
+        def update_route(route_id, options ={})
             put("routes/#{route_id}", options)
         end
 
+        alias_method :updateroute, :update_route
+
         def upload_file(file, content_type)
           request = RestClient::Request.new(
               :method => :post,
@@ -70,27 +88,36 @@ module BeetrackAPI
         private
 
         def get(path, params = {})
-            res = Curl.get(@url + request_uri(path,params)) do |http|
-                http.headers['X-AUTH-TOKEN'] = @key
-                http.headers['Content-Type'] = 'application/json'
-            end
-            JSON.parse(res.body_str)
+          request = RestClient::Request.new(
+            :method => :get,
+            :url => @url + request_uri(path, params),
+            :headers => {
+              'Content-Type' => 'application/json',
+              'X-AUTH-TOKEN' => @key
+            },
+            ssl_version: 'TLSv1_2')
+          return JSON.parse(request.execute)
         end
 
         def post(path, params ={})
-            res = Curl.post(@url + path, params.to_json) do |http|
-                http.headers['X-AUTH-TOKEN'] = @key
-                http.headers['Content-Type'] = 'application/json'
-            end
-            JSON.parse(res.body_str)
+          JSON.parse(make_request(:post, path, params))
         end
 
         def put(path, params ={})
-            res = Curl.put(@url + path, params.to_json) do |http|
-                http.headers['X-AUTH-TOKEN'] = @key
-                http.headers['Content-Type'] = 'application/json'
-            end
-            JSON.parse(res.body_str)
+          JSON.parse(make_request(:put, path, params))
+        end
+
+        def make_request(method, path, params)
+          request = RestClient::Request.new(
+            :method => method,
+            :url => @url + path,
+            :payload => params.to_json,
+            :headers => {
+              'Content-Type' => 'application/json',
+              'X-AUTH-TOKEN' => @key
+            },
+            ssl_version: 'TLSv1_2')
+          return request.execute
         end
 
         def parse(http_response)

metadata

@@ -1,32 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: beetrackapi
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nicolás Kipreos
+- Jose Luis Honorato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: curb
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: 1.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: 1.7.3
 description: A Ruby Wrapper for the Beetrack API
 email:
-- nicolas.kipreos@beetrack.in
+- nicolas.kipreos@beetrack.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -34,9 +35,8 @@ files:
 - README.md
 - beetrackapi.gemspec
 - lib/beetrackapi.rb
-homepage: http://github.com/nkipreos/
-licenses:
-- MIT
+homepage: https://github.com/Beetrack/beetrack-api-ruby
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []