indian-rail 1.0 → 1.0.1

data/README.md

@@ -1,6 +1,6 @@
 # Indian::Rail
 
-TODO: Write a gem description
+Indian Rail is a simple wrapper for finding out India train details. Please see the documentation for the proper input arguments and expected output.
 
 ## Installation
 
@@ -18,12 +18,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+To enquire the PNR status of your journey *ticket*:
+
+	response = IndianRail::Pnr.enquiry "pnr_number"
+	
+Train Schedule methods will accept either train number or train name to find the schedule of a particular *Train*:
+
+	response = IndianRail::Schedule.find "train_number"
+	
+	response = IndianRail::Schedule.find "train_name"
+	
+IndianRail will return a hash filled result something like this:
+	
+	{:pnr=>"XXXXXXX", :train_no=>"XXXX", :train_name=>"EXP", :boarding_date=>"DD-MM-YYYY", :from=>"XXX", :to=>"YYY", :reserved_upto=>"XXX"}
+
+You can even send proxy details, if you are working under proxy server
+
+	response = IndianRail::Schedule.find "train-number", :proxy => {:url => "proxy.example.com", :port => 'port_number'}
+	
+## MIT License
+
+Copyright (c) 2013 Kalyan Allampalli
+
+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/indian-rail.gemspec

@@ -1,14 +1,13 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'indian-rail/version'
 
 Gem::Specification.new do |gem|
   gem.name          = %q{indian-rail}
-  gem.version       = IndianRail::VERSION
+  gem.version       = %q{1.0.1}
   gem.authors       = ["Kalyan Allampalli"]
   gem.email         = %q{kalyan.allampalli@gmail.com}
-  gem.description   = %q{Client for the RESTful JSON Indian Rail}
+  gem.description   = %q{Client for the Indian Rail Information}
   gem.summary       = %q{Indian Rail helps you get all the required information you want to know about Indian Railways.}
   gem.homepage		= %q{https://github.com/kalyanallampalli/indian-rail}
 
@@ -18,8 +17,7 @@ Gem::Specification.new do |gem|
 	"LICENSE.txt",
 	"README.md",
 	"Rakefile",
-	"lib/indian-rail.rb",
-	"lib/indian-rail/version.rb",
+	"lib/indian-rail.rb",	
 	"lib/indian-rail/api.rb",
 	"lib/indian-rail/pnr.rb",
 	"lib/indian-rail/schedule.rb",	

data/lib/indian-rail.rb

@@ -1,4 +1,3 @@
-require_relative "./indian-rail/version"
 require_relative "./indian-rail/api"
 require_relative "./indian-rail/pnr"
 require_relative "./indian-rail/schedule"

data/lib/indian-rail/schedule.rb

@@ -1,74 +1,87 @@
 module IndianRail
-	class Schedule < Api
+	class Schedule < Api		
 		def self.find(train_no=nil, options={})
 			response = {}
 			response[:message] = 'Please Enter Train Number or Name' and return response if train_no.nil?			
 			begin
 				page_response = get_response([base_url_prefix, schedule_url_sufix].compact.join("/"), {:form_params => {'lccp_trnname' => train_no}}.merge!(options))	
-				response = parse_train_details(page_response, train_no)							
+				response = parse_train_details(page_response, train_no)
 			rescue Exception => e				
 				response[:message] = "Service is not available - #{e.message}"
 			end
 			response
 		end
 		
-		private
+		private		
 		
 		def self.parse_train_details(body, train_no)
-			page = Nokogiri::HTML(body)
-			data = {:train_no => train_no}	
-			index = 1
+			page = Nokogiri::HTML(body)			
 			tables = page.xpath('//table[@class="table_border_both"]')
 			details, train_detail = {}, {}
-			runs_on = []
-			coach_details, stn_details = [], [['Stn Code', 'Stn Name', 'Route No.', 'Arrival Time', 'Dep. time', 'Halt Time(In Min))', 'Distance', 'Day']]
-			tables.collect do |table|
-				if index == 1						
-					table.css("tr:not([@class='heading_table_top'])").collect do |row|								
-						[
-							[:train_no, 'td[1]/text()'],
-							[:train_name, 'td[2]/text()'],
-							[:runs_from, 'td[3]/text()']
-						].each do |name, xpath|
-							train_detail[name] = row.at_xpath(xpath).to_s.strip
-						end						
-						(4..10).each do |day|
-							runs_on << row.at_xpath("td[#{day}]/text()").to_s.strip
-						end		
-						train_detail[:runs_on] = runs_on.join(', ')						
-					end
-				elsif index == 2
-					table.css("tr:not([@class='heading_table_top'])").collect do |row|	
-						coach_detail = {}
-						[
-							[:title, 'td[1]/text()'],
-							['1A', 'td[2]/text()'],
-							['2A', 'td[3]/text()'],
-							['FC', 'td[4]/text()'],
-							['3A', 'td[5]/text()'],
-							['CC', 'td[6]/text()'],
-							['SL', 'td[7]/text()'],
-							['2S', 'td[8]/text()'],
-							['3E', 'td[9]/text()']
-						].each do |name, xpath|
-							coach_detail[name] = row.at_xpath(xpath).to_s.strip
+			if tables.length == 3
+				runs_on = []
+				index = 1
+				coach_details, stn_details = [], [['Stn Code', 'Stn Name', 'Route No.', 'Arrival Time', 'Dep. time', 'Halt Time(In Min))', 'Distance', 'Day']]
+				tables.collect do |table|
+					if index == 1						
+						table.css("tr:not([@class='heading_table_top'])").collect do |row|								
+							[
+								[:train_no, 'td[1]/text()'],
+								[:train_name, 'td[2]/text()'],
+								[:runs_from, 'td[3]/text()']
+							].each do |name, xpath|
+								train_detail[name] = row.at_xpath(xpath).to_s.strip
+							end						
+							(4..10).each do |day|
+								runs_on << row.at_xpath("td[#{day}]/text()").to_s.strip
+							end		
+							train_detail[:runs_on] = runs_on.join(', ')						
 						end
-						coach_details << coach_detail
-					end
-				elsif index == 3
-					table.css("tr:not([@class='heading_table_top'])").collect do |row|	
-						stn_detail = []
-						['td[2]/text()', 'td[3]/text()', 'td[4]/text()', 'td[5]/text()', 'td[6]/text()', 'td[7]/text()', 'td[8]/text()','td[9]/text()'].each do |xpath|
-							stn_detail << row.at_xpath(xpath).to_s.strip
+					elsif index == 2
+						table.css("tr:not([@class='heading_table_top'])").collect do |row|	
+							coach_detail = {}
+							[
+								[:title, 'td[1]/text()'],
+								['1A', 'td[2]/text()'],
+								['2A', 'td[3]/text()'],
+								['FC', 'td[4]/text()'],
+								['3A', 'td[5]/text()'],
+								['CC', 'td[6]/text()'],
+								['SL', 'td[7]/text()'],
+								['2S', 'td[8]/text()'],
+								['3E', 'td[9]/text()']
+							].each do |name, xpath|
+								coach_detail[name] = row.at_xpath(xpath).to_s.strip
+							end
+							coach_details << coach_detail
+						end
+					elsif index == 3
+						table.css("tr:not([@class='heading_table_top'])").collect do |row|	
+							stn_detail = []
+							['td[2]/text()', 'td[3]/text()', 'td[4]/text()', 'td[5]/text()', 'td[6]/text()', 'td[7]/text()', 'td[8]/text()','td[9]/text()'].each do |xpath|
+								stn_detail << row.at_xpath(xpath).to_s.strip
+							end						
+							stn_details << stn_detail
 						end						
-						stn_details << stn_detail
-					end						
-				end	
-				index += 1
-			end				
-			details[:train_details] = train_detail
-			details[:coach_details] = coach_details
-			details[:stn_details] = stn_details
+					end	
+					index += 1
+				end				
+				details[:train_details] = train_detail
+				details[:coach_details] = coach_details
+				details[:stn_details] = stn_details
+			else
+				stn_details = [['Train Number', 'Train Name', 'Train Source', 'Dep.Time', 'Train Destination', 'Arr.Time']]	
+				tables.collect do |table|
+					table.css("tr:not([@class='heading_table_top'])").collect do |row|					
+						train_detail = []				
+						['td[1]/input', 'td[2]/text()', 'td[3]/text()', 'td[4]/text()', 'td[5]/text()', 'td[6]/text()'].each_with_index do |xpath, i|
+							train_detail << (i == 0 ? row.at(xpath)['value'].to_i : row.at_xpath(xpath).to_s.strip)						
+						end						
+						stn_details << train_detail
+					end
+				end
+				details[:train_details] = stn_details.length == 1 ? 'Invalid Train name or data not exists' : details					
+			end
 			details			
 		end	
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indian-rail
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &16179492 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 1.5.9
   type: :runtime
   prerelease: false
-  version_requirements: *16179492
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.9
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16178952 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,8 +37,13 @@ dependencies:
         version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: *16178952
-description: Client for the RESTful JSON Indian Rail
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: Client for the Indian Rail Information
 email: kalyan.allampalli@gmail.com
 executables: []
 extensions: []
@@ -45,7 +55,6 @@ files:
 - README.md
 - Rakefile
 - lib/indian-rail.rb
-- lib/indian-rail/version.rb
 - lib/indian-rail/api.rb
 - lib/indian-rail/pnr.rb
 - lib/indian-rail/schedule.rb
@@ -70,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Indian Rail helps you get all the required information you want to know about

data/lib/indian-rail/version.rb

@@ -1,3 +0,0 @@
-module IndianRail
-    VERSION = "1.0"  
-end