traxo_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04b3987a9b2f6560ff147539d2198b375ab2cb9d
-  data.tar.gz: 0ee51e9725becd3de4c8b1c839aa3488d5d13dcd
+  metadata.gz: 908a877bad2c37d81e3118ca0d6003a4038e2e81
+  data.tar.gz: bce5e411c6ff950ef7a3580f1685a9128d1e0a89
 SHA512:
-  metadata.gz: bb2acc3e7442ec0481a47fdafe37c8c019eb241012b957e4acaeefeee9053c13667c573e6200424d8effb420fdeee10a5610ebeadd6d1a4ca122a8b17a5ebdda
-  data.tar.gz: c3b04a2d332ef8167cadbde2de1c9edf4b582f876fd855fa1aed60bf53d1c4e3046c733e750e31437f46351bb1b402d785cd41549fe14b046c939259fc08f03e
+  metadata.gz: c3f60c2f38a6c85d1f709815f1a83711c4927b16f8e732b7bcfd81b10593b26b1d2d1b2ef9ab8f2cd8374e5e0af9214d8ba7b244750b1c89052b6fe346cbe687
+  data.tar.gz: a411f7746280f1142861a8de5fdbfa464d3b8a650ef5bf07016dd136794b22feee6d033d4bbe71fbbdc4e6c7621071faaf50e790d06da95beede76f767769090

data/README.md

@@ -1,8 +1,10 @@
 #traxo_api
 
+[![Gem Version](https://badge.fury.io/rb/traxo_api.svg)](http://badge.fury.io/rb/traxo_api)
+
 The 'traxo_api' gem is a Ruby wrapper meant to simplify the processes of both authorizing applications and creating interactions with the [Traxo API](https://developer.traxo.com).  
 
-Currently, methods for the _member_, _accounts_, and _trips_ endpoints of Traxo's API have been implemented. More sections are hopefully soon to come.
+Currently, methods for the __member__, __accounts__, __trips__, and __air segments__ endpoints of Traxo's API have been implemented. More sections are hopefully soon to come.
 
 ###README Contents:  
 - [Installation](#toc-installation)  
@@ -18,12 +20,10 @@ Currently, methods for the _member_, _accounts_, and _trips_ endpoints of Traxo'
 <a name="toc-installation"></a>
 ##Installation
 
-_Note: this gem is currently in pre-release and should have its first non-pre-release within a few days_.
-
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'traxo_api', '~> 0.1.0pre'
+gem 'traxo_api'
 ```
 
 And then execute:
@@ -32,7 +32,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install traxo_api --pre
+    $ gem install traxo_api
 
 <a name="toc-usage"></a>
 ##Usage
@@ -43,6 +43,8 @@ Traxo's API uses the OAuth 2.0 standard for authorization. Additionally, Traxo e
 
 To gain authorization from a Traxo user, you will need to [register your application](https://developer.traxo.com/signup) with Traxo.  Once registered, you will need to retrieve your your _client ID_ and _client secret_ from the API's website where you will also need to register a _redirect url_ for the application.
 
+See the [__authorization documentation__](https://github.com/wilchandler/traxo_api/wiki/Authorization) for a list and detailing of available authorization methods.
+
 ####Example of authorization controller flow
 ```ruby
 class TraxoController < ApplicationController
@@ -77,8 +79,11 @@ end
 
 <a name="toc-crud"></a>
 ###CRUD
-Once a user has authorized your application and you have a valid access token, you can start making CRUD (create, read, update, delete) requests to the Traxo API on their behalf.
+Once a user has authorized your application and you have a valid access token, you can start making CRUD (create, read, update, delete) requests to the Traxo API on their behalf.  There are a multiple response formats available, and http errors/failures can be configured to be _raise exceptions_ (default), _ignored_, or to _return false_ for the CRUD method being called.
+
+See the [__endpoint documentation__](https://github.com/wilchandler/traxo_api/wiki/Client-for-Endpoints) for response formatting and error handling. Individual endpoint methods are also detailed in the documentation.
 
+####Example of getting user's Traxo details and creating a trip
 ```ruby
 t = Traxo::Client.new('ACCESS_TOKEN', 'CLIENT_ID', 'CLIENT_SECRET')
 t.get_member # => Hash of properties for user's Traxo account

data/lib/traxo/client.rb

@@ -2,7 +2,7 @@ module Traxo
 
   class Client
     attr_accessor :access_token
-    attr_reader :response_format, :raise_http_errors
+    attr_reader :response_format, :error_handling
 
     API_URL = "https://api.traxo.com/v2/"
 
@@ -44,12 +44,17 @@ module Traxo
     end
 
     def ignore_http_errors!
-      @raise_http_errors = false
+      @error_handling = :ignore
       self
     end
 
     def raise_http_errors!
-      @raise_http_errors = true
+      @error_handling = :raise
+      self
+    end
+
+    def return_false_if_http_errors!
+      @error_handling = :bool
       self
     end
 
@@ -76,14 +81,15 @@ module Traxo
 
     def assign_error_handling(action)
       if action
-        if [:raise, :ignore].include? action
+        if [:raise, :ignore, :bool].include? action
           raise_http_errors! if action == :raise
           ignore_http_errors! if action == :ignore
+          return_false_if_http_errors! if action == :bool
         else
           raise ArgumentError.new(':errors parameter must be either :raise or :ignore')
         end
       else
-        raise_http_errors!
+        ignore_http_errors!
       end
     end
 
@@ -129,7 +135,7 @@ module Traxo
       request = Net::HTTP::Delete.new(uri)
       attach_token(request)
       response = make_http_request(uri) { |http| http.request(request) }
-      check_code(response) ? true : false
+      format_response(response)
     end
 
     def query_string(data = {})
@@ -146,7 +152,6 @@ module Traxo
     end
 
     def convert_time(time)
-      time = time.dup
       if time.is_a? String
         begin
           time = Time.parse(time)
@@ -160,7 +165,7 @@ module Traxo
     end
 
     def format_response(response)
-      return false unless check_code(response)
+      return false unless check_success(response)
 
       case @response_format
       when :http
@@ -175,18 +180,21 @@ module Traxo
         response.header.each { |key| headers[key.to_sym] = response[key] }
         headers
       when :headers_string
-        response.to_json
+        headers = {}
+        response.header.each { |key| headers[key.to_sym] = response[key] }
+        headers.to_json
       when :code
         response.code.to_i
       end
     end
 
-    def check_code(response)
-      if @raise_http_errors
-        response.value || response
-      else
-        response.code <= '300'
+    def check_success(response)
+      if @error_handling == :raise
+        return response.value || response
+      elsif @error_handling == :ignore
+        return response
       end
+      response.code <= '300'
     end
   end
   

data/lib/traxo/endpoints/segments/air.rb

@@ -0,0 +1,71 @@
+module Traxo
+
+  class Client
+    def get_air_segments(args = {})
+      query = get_air_segments_options(args)
+      url = "#{API_URL}segments/air#{ query_string(query) }"
+      get_request_with_token(url)
+    end
+
+    def get_air_segment(id)
+      url = "#{ API_URL}segments/air/#{id}"
+      get_request_with_token(url)
+    end
+
+    def create_air_segment(args)
+      url = "#{ API_URL}segments/air"
+      data = create_air_segment_options(args)
+      post_request_with_token(url, data)
+    end
+
+    def update_air_segment(id, args)
+      url = "#{ API_URL}segments/air/#{id}"
+      data = create_air_segment_options(args, false)
+      data.delete_if { |key, val| !val } # previous datetime filtering is skipped
+      raise ArgumentError.new('Must provide options to update segment') if data.empty?
+      put_request_with_token(url, data)
+    end
+
+    def delete_air_segment(id)
+      url = "#{ API_URL}segments/air/#{id}"
+      delete_request_with_token(url)
+    end
+
+      private
+
+    def get_air_segments_options(args)
+      unless args.empty?
+        args = args.dup
+        options = [:start, :status, :end]
+        args.select! { |key| options.include? key }
+      end
+      args = {start: 'today'}.merge(args)
+      args[:start] = convert_time(args[:start]) unless args[:start] == 'today'
+      if args[:end] && args[:end] != 'today'
+        args[:end] = convert_time(args[:end])
+      end
+      args
+    end
+
+    def create_air_segment_options(args, enforce_required = true)
+      args = args.dup
+      args[:departure_datetime] = convert_time args[:departure_datetime]
+      args[:arrival_datetime] = convert_time args[:arrival_datetime]
+      create_air_segment_required_params(args) if enforce_required
+      options = [ :trip_id, :origin, :destination, :departure_datetime,
+                  :arrival_datetime, :airline, :flight_num, :seat_assignment,
+                  :confirmation_no, :number_of_pax, :price, :currency, :phone,
+                  :first_name, :last_name ]
+      args.keep_if { |key| options.include? key }
+    end
+
+    def create_air_segment_required_params(args)
+      required = [:trip_id, :origin, :destination, :departure_datetime,
+                  :arrival_datetime, :airline, :flight_num]
+      required.each do |arg|
+        raise ArgumentError.new("#{arg} is a required argument key") unless args[arg]
+      end
+    end
+  end
+
+end

data/lib/traxo/version.rb

@@ -1,3 +1,3 @@
 module Traxo
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/traxo_api.rb

@@ -11,4 +11,5 @@ require 'traxo/client'
 
 require 'traxo/endpoints/member'
 require 'traxo/endpoints/accounts'
-require 'traxo/endpoints/trips'
+require 'traxo/endpoints/trips'
+require 'traxo/endpoints/segments/air.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traxo_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wil Chandler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - lib/traxo/client.rb
 - lib/traxo/endpoints/accounts.rb
 - lib/traxo/endpoints/member.rb
+- lib/traxo/endpoints/segments/air.rb
 - lib/traxo/endpoints/trips.rb
 - lib/traxo/version.rb
 - lib/traxo_api.rb