local_copy 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b7d2c8b3474bfc87abd22e42799684ea8ced576
-  data.tar.gz: 7773258bd24df4cf49d24c4a2c8e18d9225f00e5
+  metadata.gz: b6e2c98eaff47998d7fcbd1ad280715b1cbdb374
+  data.tar.gz: 46e63f3f40f2e40e91c0e61254db85f20f6eddc7
 SHA512:
-  metadata.gz: e633d35fb291cb2343aafc37cf36d0c2ad33433bbdf695bfd2296680d8fed222f80e3b2d612c47361b252129e00e1f2b0960881d6baf5b264e1699a19864e1e2
-  data.tar.gz: 796bf02fd8af21a43635fba085f98827b2052564c90364742dfec09599c67a5d09d6788a8f7ea9f796383cd3bcaeb448c29cf26f33aaf73948a2c87d998aca09
+  metadata.gz: 9b6f10a8b5bce390f86d8a990b5c0431de0e85ee2b8d8024c41ef092e70622bca8d9c4cafc093de56c4715936677d2efb495fec4dd28d4d4fbf5c67161b1f653
+  data.tar.gz: 42cb886c0e8280129c321518855eecf927f2f2b0beb540d428684527557b1c6150f4f9a01dcc51799c77a8e37aa408665b612f2035b1a4bf228b47d45bd586c6

data/README.md

@@ -1,6 +1,6 @@
 # LocalCopy
 
-TODO: Write a gem description
+Keep local copies of remote files.
 
 ## Installation
 
@@ -12,19 +12,31 @@ gem 'local_copy'
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install local_copy
+```sh
+gem install local_copy
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Fetch the remote file and return a local path. For now it just
+# stores it in /tmp/local_copy_gem with the MD5 hash of the URL as a
+# name. When called again it does not download the file again.
+local_path = LocalCopy.fetch('http://example.com/some/file.xyz')
+
+# Empty the local file directory.
+LocalCopy.flush
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/local_copy/fork )
+1. Fork it ( https://github.com/ad2games/local_copy/fork )
 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`)

data/circle.yml

@@ -1,7 +1,3 @@
-deployment:
-  production:
-    branch: master
-    commands:
-      - gem install geminabox
-      - gem build local_copy.gemspec
-      - gem inabox local_copy-*.gem --host $GEMINABOX_URL
+dependencies:
+  pre:
+    - gem update bundler

data/lib/local_copy.rb

@@ -3,16 +3,15 @@ require 'digest'
 require 'open-uri'
 
 class LocalCopy
-  def self.fetch(url)
+  def self.fetch(url, &block)
     path = File.join(local_dir, Digest::MD5.hexdigest(url))
     unless File.exist?(path)
       dirname = File.dirname(path)
       Dir.mkdir(dirname) unless File.exist?(dirname)
-      File.open(path, 'wb') do |file|
-        open(url) do |url|
-          file << url.read
-        end
-      end
+      content = ''
+      open(url) { |url| content << url.read }
+      content = block.call(content) if block
+      File.open(path, 'wb') { |file| file << content }
     end
     path
   end

data/lib/local_copy/version.rb

@@ -1,3 +1,3 @@
 class LocalCopy
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/local_copy.gemspec

@@ -6,7 +6,7 @@ require 'local_copy/version'
 Gem::Specification.new do |spec|
   spec.name          = "local_copy"
   spec.version       = LocalCopy::VERSION
-  spec.authors       = ["ad2games GmbH"]
+  spec.authors       = ["Helge Rausch"]
   spec.email         = ["developers@ad2games.com"]
   spec.summary       = %q{Creates a local copy of a remote file}
   spec.description   = %q{Creates a local copy of a remote file if it doesn't already exist}

data/spec/lib/local_copy_spec.rb

@@ -8,23 +8,50 @@ describe LocalCopy do
   describe '.fetch' do
     subject { described_class.fetch(url) }
 
-    it 'fetches the remote file and returns the local path' do
-      expect(File).to receive(:exist?).with(expected_path).and_return(false)
-      expect(File).to receive(:exist?).with(File.dirname(expected_path)).and_return(false)
-      expect(Dir).to receive(:mkdir).with(File.dirname(expected_path))
-      expect(described_class).to receive(:open).with(url).and_yield(open)
-      expect(File).to receive(:open).with(expected_path, 'wb').and_yield(file)
-      expect(open).to receive(:read).and_return(file_content)
-      expect(file).to receive(:<<).with(file_content)
-
-      expect(subject).to eq(expected_path)
+    context 'file does not exist locally' do
+      before do
+        expect(File).to receive(:exist?).with(expected_path).and_return(false)
+        expect(File).to receive(:exist?).with(File.dirname(expected_path)).and_return(false)
+        expect(Dir).to receive(:mkdir).with(File.dirname(expected_path))
+        expect(described_class).to receive(:open).with(url).and_yield(open)
+        expect(File).to receive(:open).with(expected_path, 'wb').and_yield(file)
+        expect(open).to receive(:read).and_return(file_content)
+        expect(file).to receive(:<<).with(file_content)
+      end
+
+      it 'fetches the remote file and returns the local path' do
+        expect(subject).to eq(expected_path)
+      end
+
+      it "runs an optional block, passing the file's content into it" do
+        block = double('block')
+        expect(block).to receive(:call)
+        LocalCopy.fetch(url) do |content|
+          block.call
+          expect(content).to eq('foo')
+          content
+        end
+      end
     end
 
-    it 'only returns the local path if the file already exists' do
-      expect(File).to receive(:exist?).with(expected_path).and_return(true)
-      expect(described_class).not_to receive(:open)
+    context 'the file already exists locally' do
+      before do
+        expect(File).to receive(:exist?).with(expected_path).and_return(true)
+      end
+
+      it 'only returns the local path if the file already exists' do
+        expect(described_class).not_to receive(:open)
+
+        expect(subject).to eq(expected_path)
+      end
 
-      expect(subject).to eq(expected_path)
+      it 'does not run the block' do
+        block = double('block')
+        expect(block).not_to receive(:call)
+        LocalCopy.fetch(url) do |content|
+          block.call
+        end
+      end
     end
   end
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: local_copy
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
-- ad2games GmbH
+- Helge Rausch
 autorequire: 
 bindir: bin
 cert_chain: []