s3mpi 0.0.7.1 → 0.0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3609c46bafae1c25e47554f7d3930e23e71f9b9f
-  data.tar.gz: 18eb926d0d1b4ef622f5c331a4c0db33c3bbfc64
+  metadata.gz: 15963407068406352b0c91e2305bf5ef1c97d487
+  data.tar.gz: b1107fa62e9bc82a5278585c76427fb395cdda50
 SHA512:
-  metadata.gz: 4045f1202c6d63f893cf279c2c5d73b3915f105f7334d7753e389b7fc1b8b61b38af2a2e69d13a8d437934a27efda3b45fe073771c087a34a4fb8501b18ec2e4
-  data.tar.gz: 0a88adb5d33dbeac30fc180d72da67451bf7e0b47b82ed432bf614d8bf3361fa9890ba431065e73fb02e1dbf98a49d684a861ce1cafc9d77d369107b3478c2a3
+  metadata.gz: 548cd924ed23bb7e9dd0a4723182c0b0706bc195ae6b66316965d79990219acc92050a28e92557c44af3e56b8820dd2240e1737c24536993c7561bbd86c7851e
+  data.tar.gz: 00206b142dd05916ee9b138250d87ff416e68ad343142e19f7d595457f8e951d9872aa9b8a14ef8acc4c45d2c8e973ab2f0d4f8bc3ccc7404baa61267d9d8f61

data/.gitignore

@@ -6,6 +6,6 @@ Gemfile.lock
 bin
 docs/_build
 coverage
-
-.idea
 .bundle
+
+.idea

data/lib/s3mpi/converters/csv.rb

@@ -0,0 +1,37 @@
+require 'csv'
+
+module S3MPI
+  module Converters
+    module CSV
+      extend self
+
+      # Read a CSV file and convert it to an array of hashes
+      #
+      # @param [String] csv_file_path
+      #    Path to the CSV file.
+      #
+      # @param [Hash] options
+      #    Passed to CSV.parse
+      def file_to_obj(csv_file_path, options = Hash.new)
+        csv_data = File.read(csv_file_path)
+        string_to_obj(csv_data, options)
+      end
+
+      # Convert CSV string data to an array of hashes
+      #
+      # @param [String] csv_data
+      #    String of CSV data
+      #
+      # @param [Hash] options
+      #    Passed to CSV.parse
+      def string_to_obj(csv_data, options = Hash.new)
+        options = options.merge({
+                                  headers:    true,
+                                  converters: :all
+
+                                })
+        ::CSV.parse(csv_data, options).map(&:to_hash)
+      end
+    end
+  end
+end

data/lib/s3mpi/converters.rb

@@ -0,0 +1,6 @@
+require 's3mpi/converters/csv'
+
+module S3MPI
+  module Converters
+  end
+end

data/lib/s3mpi/interface.rb

@@ -1,7 +1,7 @@
 require 'json'
 require 's3mpi/format'
 require 's3mpi/s3'
-require 'csv'
+require 's3mpi/converters'
 
 module S3MPI
   class Interface
@@ -46,20 +46,20 @@ module S3MPI
     # Load a CSV file, and store the contents in S3
     # Proxies to store
     #
-    # @param [String] csv_file_path path to the CSV file.
-    #    Passed to CSV.read
+    # @param [String] csv_file_path
+    #     Path to the CSV file.
     #
     # @param [Hash] options Options hash.
-    #    Passed to CSV.read
+    #    Passed to CSV.parse
     def store_csv(csv_file_path, options = Hash.new)
-      store _load_csv(csv_file_path, options)
+      store(Converters::CSV.file_to_obj(csv_file_path, options))
     end
 
     # Store a raw object
     # @param [Object] obj
     #    The object to store.
     # @param [String] key
-    #    The key under which to save the object in the S3 bucket.
+    #    The key under which the object is saved in the S3 bucket.
     def store_raw(obj, key)
       s3_object(key).write(obj)
     end
@@ -74,6 +74,16 @@ module S3MPI
       nil
     end
 
+    # Read a CSV file from an S3 bucket. Return as array of hashes.
+    #
+    # @param [String] key
+    #    The key under which the file is saved in the S3 bucket.
+    def read_csv(key=nil)
+      Converters::CSV.string_to_obj(s3_object(key).read)
+    rescue AWS::S3::Errors::NoSuchKey
+      nil
+    end
+
     # Check whether a key exists for this MPI interface.
     # 
     # @param [String] key
@@ -97,16 +107,6 @@ module S3MPI
     def bucket
       @_bucket ||= parse_bucket @bucket
     end
-
-    private
-    def _load_csv(csv_file_path, options)
-      options = options.merge({
-                                headers: true,
-                                converters: :all
-
-                              })
-      CSV.read(csv_file_path, options).map(&:to_hash)
-    end
   end
 end
 

data/lib/s3mpi/version.rb

@@ -2,7 +2,7 @@ module S3MPI
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    PATCH = 7
+    PATCH = 8
     BUILD = 1
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/lib/s3mpi.rb

@@ -1,4 +1,5 @@
 require 's3mpi/version'
+require 's3mpi/converters'
 require 's3mpi/interface'
 
 module S3MPI

data/s3mpi.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'aws-sdk-v1'
 
   s.add_development_dependency 'rake', '~> 10.1.0'
-  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'rspec', '~> 3.4'
 
   s.extra_rdoc_files = ['README.md', 'LICENSE']
 end

data/spec/s3mpi/converters/csv_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require_relative 'parsed_csv_shared_examples'
+
+module S3MPI
+  module Converters
+    describe CSV do
+
+      let(:csv_file_path) { 'spec/support/test.csv' }
+      let(:csv_data_string) { File.read csv_file_path }
+
+      describe '#convert_to_obj' do
+        subject { described_class.string_to_obj csv_data_string }
+
+        it_behaves_like 'a parsed CSV'
+      end
+
+      describe '#file_to_obj' do
+        subject { described_class.file_to_obj csv_file_path }
+
+        it_behaves_like 'a parsed CSV'
+
+      end
+    end
+  end
+end

data/spec/s3mpi/converters/parsed_csv_shared_examples.rb

@@ -0,0 +1,21 @@
+RSpec.shared_examples 'a parsed CSV' do
+  it 'converts CSV data to an array of hashes' do
+    expect(subject).to be_kind_of Array
+
+    subject.each do |row|
+      expect(row).to be_kind_of Hash
+    end
+  end
+
+  it 'preserves integers' do
+    subject.each do |row|
+      expect(row['integer']).to eq(row['integer'].to_s.to_i)
+    end
+  end
+
+  it 'preserves floats' do
+    subject.each do |row|
+      expect(row['float']).to eq(row['float'].to_s.to_f)
+    end
+  end
+end

data/spec/s3mpi/interface_spec.rb

@@ -1,4 +1,7 @@
 require 'spec_helper'
+require 's3mpi/interface'
+require 's3mpi/converters/csv'
+require_relative '../s3mpi/converters/parsed_csv_shared_examples'
 
 module S3MPI
 
@@ -6,16 +9,18 @@ module S3MPI
 
     let(:bucket) { 'some_bucket' }
     let(:path) { 'some_folder' }
-    let(:csv_file_path) {'spec/support/test.csv'}
+    let(:csv_file_path) { 'spec/support/test.csv' }
+    let(:csv_data_string) { File.read csv_file_path }
     let(:csv_as_array_of_hashes) {
       [
-        {'user_id' => 1, 'email' => 'user1@test.com'},
-        {'user_id' => 2, 'email' => 'user2@test.com'},
-        {'user_id' => 3, 'email' => 'user3@test.com'},
+        {'integer' => 1, 'string' => 'user1@test.com', 'float' => 1.11},
+        {'integer' => 2, 'string' => 'user2@test.com', 'float' => 2.22},
+        {'integer' => 3, 'string' => 'user3@test.com', 'float' => 3.33},
       ]
     }
 
-    subject { described_class.new(bucket: bucket, path: path ) }
+    let(:interface) { described_class.new(bucket: bucket, path: path) }
+    subject { interface }
 
     describe '.store_csv' do
       it 'sends the CSV as a row of hashes to .store' do
@@ -25,6 +30,12 @@ module S3MPI
       end
     end
 
-  end
+    describe '.read_csv' do
+
+      before { allow(interface).to receive(:s3_object) { double(read: csv_data_string) } }
+      subject { interface.read_csv csv_file_path }
+      it_behaves_like 'a parsed CSV'
 
+    end
+  end
 end

data/spec/support/test.csv

@@ -1,4 +1,4 @@
-user_id,email
-1,user1@test.com
-2,user2@test.com
-3,user3@test.com
+integer,string,float
+1,user1@test.com,1.11
+2,user2@test.com,2.22
+3,user3@test.com,3.33

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3mpi
 version: !ruby/object:Gem::Version
-  version: 0.0.7.1
+  version: 0.0.8.1
 platform: ruby
 authors:
 - Robert Krzyzanowski
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.4'
 description: Passing objects between Ruby consoles can be cumbersome if the user has
   performed some serialization and deserialization procedure. S3MPI aims to enable
   simple reading and writing to S3 buckets without the typical overhead of the AWS
@@ -70,11 +70,15 @@ files:
 - README.md
 - Rakefile
 - lib/s3mpi.rb
+- lib/s3mpi/converters.rb
+- lib/s3mpi/converters/csv.rb
 - lib/s3mpi/format.rb
 - lib/s3mpi/interface.rb
 - lib/s3mpi/s3.rb
 - lib/s3mpi/version.rb
 - s3mpi.gemspec
+- spec/s3mpi/converters/csv_spec.rb
+- spec/s3mpi/converters/parsed_csv_shared_examples.rb
 - spec/s3mpi/interface_spec.rb
 - spec/s3mpi/s3_spec.rb
 - spec/spec_helper.rb
@@ -104,6 +108,8 @@ signing_key:
 specification_version: 4
 summary: Upload and download files to S3 using a very convenient API.
 test_files:
+- spec/s3mpi/converters/csv_spec.rb
+- spec/s3mpi/converters/parsed_csv_shared_examples.rb
 - spec/s3mpi/interface_spec.rb
 - spec/s3mpi/s3_spec.rb
 - spec/spec_helper.rb