forex_date 0.0.2 → 1.0.0

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rvmrc
+.idea

data/README.md

@@ -2,6 +2,26 @@
 
 Calculate the date of the current forex day.
 
+A forex week begins when the Wellington/Sydney forex markets open (Sun 5pm EST) and closes when the New York forex market closes (Fri 5pm EST).
+
+In order to calculate daily OHCL bars, the around the clock forex week can be split in 5 days:
+
+monday:    from Sun 5pm EST to Mon EST 5pm
+tuesday:   from Mon 5pm EST to Tue EST 5pm
+wednesday: from Tue 5pm EST to Wed EST 5pm
+thursday:  from Wed 5pm EST to Thu EST 5pm
+friday:    from Thu 5pm EST to Fri EST 5pm
+
+For example, if current time is Thu May 24 06:38:34 UTC 2012:
+
+> ForexDate.now
+ => Thu, 24 May 2012
+
+On saturdays and sundays it returns nil. If current time is Sat May 26 06:38:34 UTC 2012:
+
+> ForexDate.now
+ => nil
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,10 +36,6 @@ Or install it yourself as:
 
     $ gem install forex_date
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it

data/forex_date.gemspec

@@ -4,10 +4,29 @@ require File.expand_path('../lib/forex_date/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Javier Vidal"]
   gem.email         = ["javier.vidal@bolsanova.com"]
-  gem.description   = %q{Calculate the date of the current forex day}
-  gem.summary       = %q{Calculate the date of the current forex day}
-  gem.homepage      = ""
+  gem.description   = <<-END_OF_DESC
+A forex week begins when the Wellington/Sydney forex markets open (Sun 5pm EST) and closes when the New York forex market closes (Fri 5pm EST).
+
+In order to calculate daily OHCL bars, the around the clock forex week can be split in 5 days:
+
+monday:    from Sun 5pm EST to Mon EST 5pm
+tuesday:   from Mon 5pm EST to Tue EST 5pm
+wednesday: from Tue 5pm EST to Wed EST 5pm
+thursday:  from Wed 5pm EST to Thu EST 5pm
+friday:    from Thu 5pm EST to Fri EST 5pm
+
+For example, if current time is Thu May 24 06:38:34 UTC 2012:
 
+> ForexDate.now
+ => Thu, 24 May 2012
+
+On saturdays and sundays it returns nil. If current time is Sat May 26 06:38:34 UTC 2012:
+
+> ForexDate.now
+ => nil
+  END_OF_DESC
+  gem.summary       = %q{Calculate the date of the current forex day}
+  gem.homepage      = "http://github.com/javiervidal/forex_date"
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/lib/forex_date/version.rb

@@ -1,3 +1,3 @@
 module ForexDate
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/lib/forex_date.rb

@@ -6,7 +6,7 @@ module ForexDate
 
   def ForexDate.now
     t = Time.now.in_time_zone("Eastern Time (US & Canada)")
-    date = t.date
+    date = t.to_date
     date += 1.day if t.hour > 17
     return ( date.wday == 6 || date.wday == 7 ) ? nil : date
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: forex_date
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Javier Vidal
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-25 00:00:00 Z
+date: 2012-05-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: tzinfo
@@ -31,7 +31,27 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: Calculate the date of the current forex day
+description: |
+  A forex week begins when the Wellington/Sydney forex markets open (Sun 5pm EST) and closes when the New York forex market closes (Fri 5pm EST).
+  
+  In order to calculate daily OHCL bars, the around the clock forex week can be split in 5 days:
+  
+  monday:    from Sun 5pm EST to Mon EST 5pm
+  tuesday:   from Mon 5pm EST to Tue EST 5pm
+  wednesday: from Tue 5pm EST to Wed EST 5pm
+  thursday:  from Wed 5pm EST to Thu EST 5pm
+  friday:    from Thu 5pm EST to Fri EST 5pm
+  
+  For example, if current time is Thu May 24 06:38:34 UTC 2012:
+  
+  > ForexDate.now
+   => Thu, 24 May 2012
+  
+  On saturdays and sundays it returns nil. If current time is Sat May 26 06:38:34 UTC 2012:
+  
+  > ForexDate.now
+   => nil
+
 email: 
 - javier.vidal@bolsanova.com
 executables: []
@@ -49,7 +69,7 @@ files:
 - forex_date.gemspec
 - lib/forex_date.rb
 - lib/forex_date/version.rb
-homepage: ""
+homepage: http://github.com/javiervidal/forex_date
 licenses: []
 
 post_install_message: