web_font 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0d8d2461c2cb78dac3588cd7931d18df3b224fd
-  data.tar.gz: 29d992b865a5269e535c67a5d570080911a2f88d
+  metadata.gz: 184ff8a59aa7e27841c201f7c93f93a6f0eb97c3
+  data.tar.gz: 48911740783864c288235ef96f946537fb441f54
 SHA512:
-  metadata.gz: 960e90afc819598b1aec864e99ae752dbe19067ffe1c176a083fdda32d57ad78ae3b9a4051ce0a98ff926788b0e1b48a84a3bb54c593d755e6c50f45eac60e03
-  data.tar.gz: 99006b36361eaf44927a527009f1f6f677d8cb7440bc5ce2a753bf9cba10e0afc7c6335f6a94a1a33b510c343582824cb7da1ebd250759465f3758ca066bb3b4
+  metadata.gz: 1a330371700105c9818a37457e735aa32021f9bea2a4a2a7882adaca587d8c61b5dbcaeb1cc68546ee0f5028c5bb1a13c8dccf4458cfb12daf37df47dbb3ad5a
+  data.tar.gz: 8c98d1c58047a4429ff5359297b45a419f25ab6632935468855465f279a69f2b83c10ca747d63f4b2f56bd1e5ee7caf787214c4ed3825c5628f6c50097995189

data/README.md

@@ -1,6 +1,6 @@
 # WebFont
 
-TODO: Write a gem description
+WebFont is a Ruby library that will help you download fonts from Google. For now, we support only [Google Font](http://www.google.com/fonts).
 
 ## Installation
 
@@ -16,9 +16,36 @@ Or install it yourself as:
 
     $ gem install web_font
 
+## Dependencies
+
+WebFont depends on [wget](http://en.wikipedia.org/wiki/Wget). Make sure you have it installed first.
+
+For Ubuntu:
+```
+sudo apt-get install wget
+```
+
+To download font from Google, you need to have [Google API Key](https://www.google.com/search?q=google+api+key), then set ``GOOGLE_API_KEY`` environment variable.
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'web_font'
+
+ENV['GOOGLE_API_KEY'] = '...'
+WebFont::Data.path    = '/some/where/in/your/disk'
+
+# First you need to have font index
+WebFont::Data.download
+
+# Then you can download font 'Open Sans' and store it in /users/foo
+downloader = WebFont::Downloader.new
+downloader.download('Open Sans', '/users/foo')
+
+# You can also find font in index as well
+finder = WebFont::Finder.new
+finder.find('Open Sans')
+```
 
 ## Contributing
 

data/lib/web_font/data.rb

@@ -8,30 +8,52 @@ module WebFont
       attr_accessor :path
     end
 
-    # Download fonts data from Google and index it
+    # Download font index from Google, save it locally and index it.
+    #
+    # fonts.json schema:
+    # {
+    #   "kind": "webfonts#webfontList",
+    #   "items": [
+    #     {
+    #       "kind": "webfonts#webfont",
+    #       "family": "ABeeZee",
+    #       "variants": [
+    #         "regular",
+    #         "italic"
+    #       ],
+    #       "subsets": [
+    #         "latin"
+    #       ],
+    #       "version": "v1",
+    #       "lastModified": "2013-12-16",
+    #       "files": {
+    #         "regular": "http://themes.googleusercontent.com/static/fonts/abeezee/v1/mE5BOuZKGln_Ex0uYKpIaw.ttf",
+    #         "italic": "http://themes.googleusercontent.com/static/fonts/abeezee/v1/kpplLynmYgP0YtlJA3atRw.ttf"
+    #       }
+    #     },
+    #     { ... },
+    #     { ... }
+    #   ]
+    # }
     #
     # Returns nothing
     def self.download
-      assert_path!
+      raise ArgumentError, 'path is empty' unless path
       raise ArgumentError, "ENV['GOOGLE_API_KEY'] is nil" unless ENV['GOOGLE_API_KEY']
 
       FileUtils.mkdir_p(path) unless Dir.exist?(path)
 
       url = "https://www.googleapis.com/webfonts/v1/webfonts?key=#{ENV['GOOGLE_API_KEY']}"
-      system("wget -O #{path}/fonts.json #{url}")
+      system("wget -q -O #{path}/fonts.json #{url}")
 
       index
     end
 
-    def self.assert_path!
-      raise ArgumentError, 'path is empty' unless path
-    end
-
     private
 
-    # Index fonts data so it will speed things up when search
-    #
-    # Returns nothing
+      # Index font data so it will speed things up when searching
+      #
+      # Returns nothing
       def self.index
         indices           = {}
         alphabet          = 'a'

data/lib/web_font/downloader.rb

@@ -21,7 +21,7 @@ module WebFont
         filename = File.join(destination_path, "#{font_family}-#{variant}")
         extname  = File.extname(url)
 
-        system("wget -O #{filename}#{extname} #{url}") unless File.exist?("#{filename}#{extname}")
+        system("wget -q -O #{filename}#{extname} #{url}") unless File.exist?("#{filename}#{extname}")
       end
     end
   end

data/lib/web_font/version.rb

@@ -1,3 +1,3 @@
 module WebFont
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end