rails_google_fonts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63c16bf3c801ed93c064597b11e1f845a56ce75a
+  data.tar.gz: 263a4fa532dc5ab095236ab87900d51be6759a19
+SHA512:
+  metadata.gz: 2910a6589694e55a4c23cc900fcc6b227373dd414a5045ce58f3c8d88a4eb809cee5f198ac041eb69e0e94c5c13b42740d8fe0bcc015e4dbbe8252664c0aeb8c
+  data.tar.gz: 2fb3d4e79a62f27a68b0cd3026f81ef673caf5398a90db372f7ee6d42b650052627cfa03149b2516a1bd0f3a89adf6f21f39f1242ce2e05bbd7458c68dd67365

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.gem
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_google_fonts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2015 syaffers
+
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# RailsGoogleFonts
+
+Rails Google Fonts is a gem/wrapper to ease the use of Google Fonts with your Rails app. It's more of an API client sort of thing.
+
+## Requirements
+
+Your Google Developer API key. You can get one at [https://console.developers.google.com/](https://console.developers.google.com/) (you will need to create a project, if you haven't already!).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_google_fonts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_google_fonts
+
+## Usage
+
+### Setup
+
+Include your Google Developer API key. Tip: Store your API key in the environment variable for extra security!
+
+```ruby
+RailsGoogleFonts.key(ENV['GOOGLE_API_KEY'])
+```
+or (unsafe!)
+
+```ruby
+RailsGoogleFonts.key('YOUR_GOOGLE_API_KEY')
+```
+
+### Get all the fonts
+
+Simply:
+
+```ruby
+RailsGoogleFonts.all # Returns a list of object containing all the fonts
+```
+
+This will raise an error if the API key is not set
+
+### Get all fonts sorted by a parameter
+
+Get a sorted list of all the fonts, sorted by a parameter. Possible parameters are (shamelessly copied from [https://developers.google.com/fonts/docs/developer_api](https://developers.google.com/fonts/docs/developer_api)):
+
++   alpha: Sort the list alphabetically
++   date: Sort the list by date added (most recent font added or updated first)
++   popularity: Sort the list by popularity (most popular family first)
++   style: Sort the list by number of styles available (family with most styles first)
++   trending: Sort the list by families seeing growth in usage (family seeing the most growth first)
+
+Example:
+
+```ruby
+RailsGoogleFonts.all_by('trending')
+```
+
+Setting an invalid parameter will raise an error
+
+### Filter by font category
+
+Filter the fonts using the `category` function. Known font categories are:
+
++   serif
++   sans-serif
++   monospace
++   handwriting
++   display
+
+Example:
+
+```ruby
+RailsGoogleFonts.category('sans-serif') # Returns a list of objects in the sans-serif category
+```
+
+Returns an empty array for invalid categories
+
+## Testing
+
+Test the build by running `rake test`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails_google_fonts/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+

data/lib/rails_google_fonts.rb

@@ -0,0 +1,86 @@
+require "rails_google_fonts/version"
+require "httparty"
+
+module RailsGoogleFonts
+  include HTTParty
+
+  # Set Google API key for access to the fonts API
+  #
+  # Example:
+  #   >> RailsGoogleFonts.key(ENV['GOOGLE_API_KEY'])
+  #   => {:query {:key => "1234567890ASDasdASAsdasdASDASdad}}
+  #
+  # Arguments:
+  #   key: (String)
+
+  def self.key(key)
+    @key = key
+    @options = { query: {key: @key} }
+  end
+
+  # Get all fonts from the Google Fonts API
+  #
+  # Example:
+  #   >> RailsGoogleFonts.all
+  #   => [..., {"family"=>"Reenie Beanie", "category"=>"handwriting", "variants"=>["regular"], ...}, ...]
+
+  def self.all
+    if @key
+      @options[:query][:sort] = 'alpha'
+      response = HTTParty.get('https://www.googleapis.com/webfonts/v1/webfonts', @options).parsed_response
+
+      if response['error']
+        raise "Unexpected error: #{response['error']['errors'][0]['reason']}"
+        return response['error']
+      else
+        return response['items']
+      end
+
+    else
+      raise "Google API key is not set"
+    end
+  end
+
+  # Get all fonts sorted by a parameter
+  #
+  # Example:
+  #   >> RailsGoogleFonts.all_by('trending')
+  #   => [{..., "family"=>"Amita", ...}, ...]
+  #
+  # Arguments:
+  #   sort: (String)
+
+  def self.all_by(sort='alpha')
+    if @key
+      @options[:query][:sort] = sort
+      response = HTTParty.get('https://www.googleapis.com/webfonts/v1/webfonts', @options).parsed_response
+
+      if response['error']
+        raise "Unexpected error: #{response['error']['errors'][0]['reason']}"
+        return response['error']
+      else
+        return response['items']
+      end
+
+    else
+      raise "Google API key is not set"
+    end
+  end
+
+  # Get all fonts from a category
+  #
+  # Example:
+  #   >> RailsGoogleFonts.category('display')
+  #   => [..., {..., "family"=>"Sniglet", "category"=>"display", ...}, ...]
+  #
+  # Arguments:
+  #   category: (String)
+
+  def self.category(category)
+    if @key
+      return RailsGoogleFonts.all.select { |a| a['category'] == category }
+    else
+      raise "Google API key is not set"
+    end
+  end
+end

data/lib/rails_google_fonts/version.rb

@@ -0,0 +1,3 @@
+module RailsGoogleFonts
+  VERSION = "0.0.1"
+end

data/rails_google_fonts.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_google_fonts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_google_fonts"
+  spec.version       = RailsGoogleFonts::VERSION
+  spec.authors       = ["Syafiq Kamarul Azman"]
+  spec.email         = ["syafiqkamarulazman@hotmail.com"]
+  spec.summary       = %q{Rails Google Fonts is a gem/wrapper to ease the use of Google Fonts with your Rails app}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/syaffers/rails_google_fonts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "httparty", "~> 0.13.5"
+end

data/test/test_rails_google_fonts.rb

@@ -0,0 +1,92 @@
+require 'minitest/autorun'
+require_relative '../lib/rails_google_fonts'
+
+describe "setting key" do
+  describe "no key being input" do
+    it "raises an argument error" do
+      proc { RailsGoogleFonts.key }.must_raise ArgumentError
+    end
+  end
+
+  describe "key is input" do
+    it "sets the key sucessfully" do
+      RailsGoogleFonts.key('ABC123')[:query][:key].must_equal 'ABC123'
+    end
+  end
+end
+
+describe "key not set" do
+  describe "get all fonts" do
+    it "raises a key not set error" do
+      proc { RailsGoogleFonts.all }.must_raise RuntimeError
+    end
+  end
+
+  describe "get all fonts sorted in a given order" do
+    it "raises an invalid key error" do
+      proc { RailsGoogleFonts.all_by("alpha") }.must_raise RuntimeError
+    end
+  end
+
+    describe "get all fonts filtered by category" do
+      it "raises an invalid key error" do
+      proc { RailsGoogleFonts.category("serif") }.must_raise RuntimeError
+    end
+  end
+end
+
+describe "invalid key" do
+  before do
+    RailsGoogleFonts.key("abcABC123")
+  end
+
+  describe "get all fonts" do
+    it "raises an invalid key error" do
+      proc { RailsGoogleFonts.all }.must_raise RuntimeError
+    end
+  end
+
+  describe "get all fonts sorted in a given order" do
+    it "raises an invalid key error" do
+      proc { RailsGoogleFonts.all_by("alpha") }.must_raise RuntimeError
+    end
+  end
+
+  describe "get all fonts filtered by category" do
+    it "raises an invalid key error" do
+      proc { RailsGoogleFonts.category("serif") }.must_raise RuntimeError
+    end
+  end
+end
+
+describe "valid key" do
+  before do
+    RailsGoogleFonts.key(ENV["GOOGLE_API_KEY"])
+  end
+
+  describe "get all fonts" do
+    it "returns all fonts" do
+      RailsGoogleFonts.all.must_be_instance_of Array
+    end
+  end
+
+  describe "get all fonts sorted in a given order" do
+    it "returns all fonts sorted in alphabetical order" do
+      RailsGoogleFonts.all_by("alpha").must_be_instance_of Array
+    end
+
+    it "raises an invalid parameter error" do
+      proc { RailsGoogleFonts.all_by("invalid_parameter") }.must_raise RuntimeError
+    end
+  end
+
+  describe "get all fonts filtered by category" do
+    it "returns all fonts in serif category" do
+      RailsGoogleFonts.category("serif")[0]["category"].must_equal 'serif'
+    end
+
+    it "returns empty array for an invalid category" do
+      RailsGoogleFonts.category("invalid_category").must_be_empty
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rails_google_fonts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Syafiq Kamarul Azman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+description: ''
+email:
+- syafiqkamarulazman@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_google_fonts.rb
+- lib/rails_google_fonts/version.rb
+- rails_google_fonts.gemspec
+- test/test_rails_google_fonts.rb
+homepage: https://github.com/syaffers/rails_google_fonts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Rails Google Fonts is a gem/wrapper to ease the use of Google Fonts with
+  your Rails app
+test_files:
+- test/test_rails_google_fonts.rb