quandl_location 0.1.2 → 0.2.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # quandl_location changelog
 
+## 0.2.0
+
+* Remove Quandl::Location::Data.find. Add Quandl::Location.find to return instance of Data class.
+* Quandl::Location::Data does not have to be directly accessed.
+* 0.2.0 introduces breaking changes and is not compatible with 0.1.x 
+
 ## 0.1.2
 
 * Add save_data! method to send data directly to storage engine, bypassing raw_data and data_changed validation.

data/README.md

@@ -69,16 +69,16 @@ File system stores location data using the location_id as the file name.
 Creates new key, or overwrites existing key with new data.
 
 ``` ruby
-location_data = Quandl::Location::Data.find(location_id)
-location_data.data = [1,2,3]
-location_data.save
+location = Quandl::Location.find(location_id)
+location.data = [1,2,3]
+location.save
 ```
 
 To send data directly to storage engine (and to bypass changed? validation and setting via data=) use save_data! method.  
 
 ```ruby
-location_data = Quandl::Location::Data.find(location_id)
-location_data.save_data!([1,2, 3])
+location = Quandl::Location.find(location_id)
+location.save_data!([1,2, 3])
 ```
 
 #### Retrieve data
@@ -86,7 +86,7 @@ location_data.save_data!([1,2, 3])
 Returns the data, or returns nil if data does not exist.
 
 ```ruby
-raw_data = Quandl::Location::Data.find(location_id).data
+raw_data = Quandl::Location.find(location_id).data
 ```
 
 #### Check for data
@@ -96,13 +96,13 @@ Use exists? method to check if the data exits in the storage engine. The get met
 Quandl::Storage::Redis returns true if there is a key with value location_id, and Quandl::Storage::FileSystem returns true if there is a file present with name location_id.
 
 ```ruby
-location_data = Quandl::Location::Data.find(new_location_id)
-location_data.exists?
+location = Quandl::Location.find(new_location_id)
+location.exists?
 => false
-location_data.data = [1,2,3]
-location_data.exists?
+location.data = [1,2,3]
+location.exists?
 => false
-location_data.save
-location_data.exists?
+location.save
+location.exists?
 => true
 

data/lib/quandl/location.rb

@@ -14,6 +14,15 @@ module Quandl
         
     class << self
       
+      # Create a new instance of Quandl::Locatin::Data
+      #
+      # id - Location id Fixnum
+      #
+      # Returns Quandl::Location::Data
+      def find(id)
+        Quandl::Location::Data.new(id)
+      end
+      
       # The list of supported storage engines for locations
       #
       # Returns array

data/lib/quandl/location/data.rb

@@ -2,19 +2,6 @@ module Quandl
   module Location
     class Data
       
-      class << self
-        
-        # Create a new location data instance
-        #
-        # id - The location id 
-        # 
-        # Returns Quandl::Location::Data 
-        def find(id)
-          self.new(id)
-        end
-        
-      end
-      
       attr_accessor :id, :data
       
       # Constructor

data/lib/quandl/location/version.rb

@@ -1,5 +1,5 @@
 module Quandl
   module Location
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/spec/quandl/location/data_spec.rb

@@ -11,14 +11,6 @@ describe Quandl::Location::Data do
   before(:each) do
     Quandl::Location::Data.any_instance.stub(:storage).and_return(storage_mock)
   end
-
-  describe '#find' do
-    
-    it 'should return a new Quandl::Location::Data instance' do
-      Quandl::Location::Data.find(230).should be_kind_of(Quandl::Location::Data)
-    end
-    
-  end
   
   describe '#data=' do
     

data/spec/quandl/location_spec.rb

@@ -18,6 +18,16 @@ describe Quandl::Location do
     
   end
   
+  describe '#find' do
+    
+    it 'should return a new Location data instance' do
+      location_id = (1..100).to_a.sample
+      Quandl::Location::Data.should_receive(:new).with(location_id)
+      Quandl::Location.find(location_id)
+    end
+    
+  end
+  
   describe '#use' do
     
     it 'it should raise an error for unsupported storage engines' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quandl_location
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler