rails-rail-in 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9be7bcc798e3ecb598de3733fb68ec2ed902a6ab
-  data.tar.gz: 191133bbf5e3fe538c8e437d39bc003964c78e6b
+  metadata.gz: 1ccdc54e9be2408e55cc03ae35f15403941c05c6
+  data.tar.gz: e4ae841e603b31be7a4506ede9ff7be630417eec
 SHA512:
-  metadata.gz: 670fb33878a91e18570b29468fff43d650fcabd490ca0cc8de80ba1b13e3d3b3f8c7fdaedb5da9ff619210bde3229b3da74b8ad9cdbf16440e84e865a80e3a52
-  data.tar.gz: 253d1a2efb799e9991b66cfdf455bb845ee73688463bf58c98a51537eec3fb880bdcfe29b240646b2dc004381fb7694a1055fb030cf134721e1fba38ca093501
+  metadata.gz: 78043d1bcb275762c164a3d4d8574dd049d8427b3b18144c5578e896ab57ea301c87fea2ded75acc154e6b6574d26bf46daffd251ca34a09a48f0d6db97f69de
+  data.tar.gz: bb1c46a2252ad33171318d6082987775fc5b4b4a80cf5c8f328e5e64ae2417c036ea99e7219a3eb5194571b6686200d0e54df969487673bdb14d0c01ba277e74

data/README.md

@@ -1,27 +1,89 @@
 # Rails::Rail::In
 
-Indian Railways Trains, PNR Status, Features to come IRCTC Availability, Running Status, Map, Arrival Departure, Route, Fare Check...
+rails-rail-in is to find an Indian Railways Info like Train Lists, Station Lists, Routes, Fare, PNR Status, Seat Availabilities and more.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install using Bundler grab the latest stable version:
 
 ```ruby
-gem 'rails-rail-in'
+gem 'rails-rail-in', '~> 1.0.0'
 ```
 
-And then execute:
+To manually install rails-rail-in via Rubygems simply gem install:
 
-    $ bundle
+    $ gem install rails-rail-in
 
-Or install it yourself as:
+## API Key
 
-    $ gem install rails-rail-in
+To get an API key go to: http://api.erail.in/#api_key and send a email request to eRail Team.
 
 ## Usage
 
-var1 	=	Rails::Rail::In.pnr_status(your_pnr_number)
-# You will get JSON response
+```ruby
+rail_in =	RailIn.new(eRailKey)
+```
+### Stations List
+
+Get the result of all the stations with their station code, name, latitude and longitude.
+
+```json
+
+rail_in.stations
+
+output:
+-------
+	{
+		"status" : "OK",
+		"result" : [
+			{ 
+				"code" : "NDLS",
+				"name" : "New Delhi"
+			},
+			{ 
+				"code" : "BCT",
+				"name" : "Mumbai Central"
+			},
+			....
+		]
+	}
+```
+
+### PNR Status
+
+Get details of given PNR number.
+
+```json
+
+rail_in.pnr_status(pnr_number)
+
+output:
+-------
+	{
+		"status" : "OK",
+		"result" :  { 
+			"pnr" : "6533543051",
+			"eticket" : true,
+			"journey" : "09-Sep-2014",
+			"trainno" : "12898",
+			"name" : "BBS PDY EXPRESS",
+			"from" : "VZM",
+			"to" : "MS",
+			"brdg" : "VZM",
+			"passengers" : 
+				[
+					{
+					"bookingstatus" : "RAC 14GNWL",
+					"currentstatus" : "B3 14",
+					"coach" : ""
+					},
+					....
+				],
+			"chart" : "CHART PREPARED",
+			"error" : ""
+		}
+	}
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,11 @@
 require "bundler/gem_tasks"
 
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+

data/bin/sample

@@ -0,0 +1,3 @@
+require 'rails-rail-in'
+puts "a = RailIn.new"
+puts "a.pnr_status(YOUR PNR Number)"

data/lib/rails-rail-in.rb

@@ -0,0 +1,2 @@
+require "rails-rail-in/rail_in"
+require "rails-rail-in/request"

data/lib/rails-rail-in/rail_in.rb

@@ -0,0 +1,67 @@
+#module Rails
+  class RailIn
+    attr_accessor :erail_key
+
+    def initialize(erail_key, options = {})
+      puts "options: #{options}"
+      puts "erail_key: #{erail_key}"
+      @erail_key = erail_key
+    end
+
+    def stations
+      url = "#{base_url}/stations/?key=#{erail_key}"
+      Request.query url
+    end
+
+    def trains(from, to, options = {})
+      puts "erail_key: #{erail_key}"
+      date = options[:date]
+      class_code = options[:class_code]
+      url = "#{base_url}/trains/?key=#{erail_key}&stnfrom=#{from}&stnto=#{to}&date=#{date}&class=#{class_code}"
+      Request.query url
+    end
+
+    def route(train_no)
+      url = "#{base_url}/route/?key=#{erail_key}&trainno=#{train_no}"
+      Request.query url
+    end
+
+    def full_route(train_no)
+      url = "#{base_url}/fullroute/?key=#{erail_key}&trainno=#{train_no}"
+      Request.query url
+    end
+
+    def fare(train_no, from, to, age, quota, run_date, options = {})
+      class_code = options[:class_code]
+      url = "#{base_url}/fare/?key=#{erail_key}&trainno=#{train_no}&stnfrom=#{from}&stnto=#{to}&age=#{age}&quota=#{quota}&class=#{class_code}&date=#{run_date}"
+      Request.query url
+    end
+
+    def pnr_status(pnr_no)
+      url = "#{base_url}/pnr?key=#{erail_key}&pnr=#{pnr_no}"
+      Request.query url
+    end
+
+    def live_status(train_no, from, run_date)
+      url = "#{base_url}/live/?key=#{erail_key}&trainno=#{train_no}&stnfrom=#{from}&date=#{run_date}"
+      Request.query url
+    end
+
+    def seat_availability(train_no, from, to, quota, class_code, run_date)
+      url = "#{base_url}/seats/?key=#{erail_key}&trainno=#{train_no}&stnfrom=#{from}&stnto=#{to}&quota=#{quota}&class=#{class_code}&date=#{run_date}"
+      Request.query url
+    end
+
+    def train_at_station(from, to, hour)
+      url = "#{base_url}/trainsatstation/?key=#{erail_key}&stnfrom=#{from}&stnto=#{to}&hr=#{hour}"
+      Request.query url
+    end
+
+    def base_url
+      "http://api.erail.in"
+    end
+    # "fd3ebf59-3ed8-424f-a99d-5cfad4337d94"
+
+  end
+#end
+

data/lib/rails-rail-in/request.rb

@@ -0,0 +1,9 @@
+require 'rest_client'
+require 'json'
+class Request
+
+	def self.query(url)
+		JSON.parse RestClient.get url
+	end
+
+end

data/rails-rail-in.gemspec

@@ -1,23 +1,28 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rails/rail/in/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rails-rail-in"
-  spec.version       = Rails::Rail::In::VERSION
+  spec.version       = "1.0.0"
+  spec.date          = "2014-12-14"
   spec.authors       = ["psaravanan11"]
   spec.email         = ["psaravanan11@gmail.com"]
   spec.summary       = %q{Indian Railways Trains, PNR Status}
   spec.description   = %q{Indian Railways Trains, PNR Status, Features to come IRCTC Availability, Running Status, Map, Arrival Departure, Route, Fare Check...}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/psaravanan/rails-rail-in"
   spec.license       = "MIT"
-  spec.rubyforge_project = "rest_client"
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.metadata = { "issue_tracker" => "http://www.psaravanan.in" }
+  spec.post_install_message = "Thanks for installing! by Saravanan P"
+  spec.requirements << 'rest_client, ~> 1.6'
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "rest_client", "~> 1.6"
 end

data/test/test_rail_in.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'rails-rail-in'
+
+class RailInTest < Minitest::Test
+  def test_base_url
+    assert_equal "http://api.erail.in/",
+      RailIn.new.base_url
+  end
+end

metadata

@@ -1,83 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: rails-rail-in
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - psaravanan11
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rest_client
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: Indian Railways Trains, PNR Status, Features to come IRCTC Availability,
-  Running Status, Map, Arrival Departure, Route, Fare Check...
+        version: '1.6'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  prerelease: false
+  type: :runtime
+description: Indian Railways Trains, PNR Status, Features to come IRCTC Availability, Running Status, Map, Arrival Departure, Route, Fare Check...
 email:
 - psaravanan11@gmail.com
-executables: []
+executables:
+- sample
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/rails/rail/in.rb
-- lib/rails/rail/in/version.rb
+- bin/sample
+- lib/rails-rail-in.rb
+- lib/rails-rail-in/rail_in.rb
+- lib/rails-rail-in/request.rb
 - rails-rail-in-0.0.1.gem
 - rails-rail-in-0.0.2.gem
+- rails-rail-in-0.0.3.gem
 - rails-rail-in.gemspec
-homepage: ''
+- test/test_rail_in.rb
+homepage: https://github.com/psaravanan/rails-rail-in
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  issue_tracker: http://www.psaravanan.in
+post_install_message: Thanks for installing! by Saravanan P
 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: rest_client
-rubygems_version: 2.4.4
-signing_key: 
+requirements:
+- rest_client, ~> 1.6
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Indian Railways Trains, PNR Status
-test_files: []
+test_files:
+- test/test_rail_in.rb

data/lib/rails/rail/in.rb

@@ -1,16 +0,0 @@
-require "rails/rail/in/version"
-require 'rest_client'
-
-module Rails
-  module Rail
-    module In
-      def self.pnr_status(pnr_no)
-      	RestClient.get "http://api.erail.in/pnr?key=fd3ebf59-3ed8-424f-a99d-5cfad4337d94&pnr=#{pnr_no}"
-      end
-
-      def self.base_url
-      	"http://api.erail.in/"
-      end
-    end
-  end
-end

data/lib/rails/rail/in/version.rb

@@ -1,7 +0,0 @@
-module Rails
-  module Rail
-    module In
-      VERSION = "0.0.3"
-    end
-  end
-end