fonts_dot_com 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d17a2cf6d933dee1711c16f12293941a40171d98
+  data.tar.gz: a593374bdd3c01be400953e16c0ddd08df58d3c0
+SHA512:
+  metadata.gz: f9c687efab91dcdc3855e2073cc3410faa8bd69894553b6564edfc5e2cd49e79e95dabba42ab7f38fe9ab79714a64207a818af7edb3db61fe28789697c57d03d
+  data.tar.gz: 20d9ac8dcef38ebeaf3d93ee2fc54d29341eeb925e48793f574b0527b82c7712ba5e652f6e3d916d2f6d7cee0276e79bea6274c5e816e253286f1754ad76a498

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/config/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Friel
+
+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,67 @@
+# FontsDotCom
+
+This is a simple wrapper for communicating with the fonts.com API. The fonts.com API requires signing calls with a hash that's not trivial to generate, which rules out e.g. playing around with curl. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fonts_dot_com'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fonts_dot_com
+
+## Usage
+
+### API key
+
+Before you can use the fonts.com API, you need an API key. You can request a key here:
+https://www.fonts.com/web-fonts/developers/request-api-key
+
+### Configuration
+
+`FontsDotCom` needs to be configured with your credentials before you can make API calls. 
+
+```ruby
+irb> require 'fonts_dot_com'
+irb> FontsDotCom.configure do |config|
+irb>   config.api_key      = 'whatever'
+irb>   config.public_key   = 'whatever' # This, and the private key are generated
+irb>   config.private_key  = 'whatever' # from the API key.
+irb> end
+
+```
+In a Rails app, you'd want to put the above in an initializer.
+
+### API calls
+
+Until I write up some better documentation, here's the gist:
+
+```ruby
+response = FontsDotCom::Api.list_projects
+=> #<FontsDotCom::Response:0x007fdfdc1db2d0 @original_response_object=#<Net::HTTPOK 200 OK readbody=true>, @body={ :lots => :here }, @code="200">
+irb> response.class
+=> FontsDotCom::Response
+irb> response.body.class
+=> Hash
+irb> response.body.keys
+=> ["Projects"]
+```
+
+See lib/fonts_dot_com/api.rb for other calls.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/Postcontext/fonts_dot_com/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fonts_dot_com"
+
+# Feel free to change these if you'd like to store your config file(s)
+# somewhere else.
+config_dir      = './config/'
+config_filename = 'fonts_dot_com.yml'
+
+config_file     = config_dir + config_filename
+
+if Dir.exists?(config_dir) && File.exists?(config_file)
+
+  CONFIG = YAML.load_file(config_file)
+  
+  FontsDotCom.configure do |config|
+    config.public_key   = CONFIG['public_key']
+    config.private_key  = CONFIG['private_key']
+    config.api_key      = CONFIG['api_key']
+  end
+end
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fonts_dot_com.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fonts_dot_com/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fonts_dot_com"
+  spec.version       = FontsDotCom::VERSION
+  spec.authors       = ["John Friel"]
+  spec.email         = ["john@johnfriel.net"]
+
+  spec.summary       = %q{For making requests to fonts.com API.}
+  spec.description   = %q{Gem for making requests to fonts.com API.}
+  spec.homepage      = "https://github.com/Postcontext/fonts_dot_com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fonts_dot_com.rb

@@ -0,0 +1,16 @@
+require "fonts_dot_com/version"
+require "fonts_dot_com/config"
+require "fonts_dot_com/auth_param"
+require "fonts_dot_com/request"
+require "fonts_dot_com/response"
+require "fonts_dot_com/api"
+
+module FontsDotCom
+
+  class << self
+    def configure(&block)
+      FontsDotCom::Config.configure(&block)
+    end
+  end
+
+end

data/lib/fonts_dot_com/api.rb

@@ -0,0 +1,255 @@
+module FontsDotCom
+  class Api
+    class << self
+
+      ##
+      #
+      # Projects
+      #
+      ##
+      
+      # http://www.fonts.com/web-fonts/developers/api/list-projects
+      def list_projects(options={})
+        base_path = '/rest/json/Projects/'
+        limit     = options[:limit]  || 10
+        offset    = options[:offset] || 0
+      
+        path = "#{base_path}?wfsplimit=#{limit}&wfspstart=#{offset}"
+
+        puts "path is: #{path}"
+
+        args = options.merge({
+          message:  path,
+          method:   :get
+        })
+
+        FontsDotCom::Request.fire(args)
+      end
+
+      # http://www.fonts.com/web-fonts/developers/api/add-project
+      def add_project(name)
+        unless ( name.is_a? String ) && ( name.length > 0 )
+          raise ArgumentError
+        end
+        
+        data = {
+          wfsproject_name: name
+        }
+        
+        response = FontsDotCom::Request.fire({
+          message:  '/rest/json/Projects/',
+          method:   :post,
+          data:     data
+        })
+      end
+   
+      # http://www.fonts.com/web-fonts/developers/api/delete-project
+      def delete_project(project_id)
+        raise ArgumentError unless project_id
+        
+        response = FontsDotCom::Request.fire({
+          message:  "/rest/json/Projects/?wfspid=#{project_id}",
+          method:   :delete
+        })
+      end
+      
+      
+      
+      ##
+      #
+      # Stylesheets
+      #
+      ##
+      
+      # https://www.fonts.com/web-fonts/developers/api/export
+      def export_stylesheet(project_id)
+        base_path = '/rest/json/ProjectStylesExport/'
+        path      = "#{base_path}?wfspid=#{project_id}"
+        
+        FontsDotCom::Request.fire({
+          message:  path,
+          method:   :get
+        })
+      end
+
+      # https://www.fonts.com/web-fonts/developers/api/import
+      def import_stylesheet(project_id, project_token)
+        # NOTE: get `ProjectToken` from #export_stylesheet
+        #   `project_id` is the ID of the recipient project
+        #   `project_token` is the token from the project whose
+        #     stylesheet is being imported
+
+        base_path = '/rest/json/ProjectStylesExport/'
+        path      = "#{base_path}?wfspid=#{project_id}&wfsptoken=#{project_token}"
+        
+        FontsDotCom::Request.fire({
+          message:  path,
+          method:   :get
+        })
+      end
+
+      # https://www.fonts.com/web-fonts/developers/api/add-stylesheet
+      def add_stylesheet
+      end
+
+
+
+
+      ###
+      # 
+      # Project Fonts
+      #
+      ###
+
+      def list_project_fonts(project_id, options={})
+        # `project_id` should be fonts.com's project ID (returned as
+        # `ProjectKey` by the API.)
+        raise ArgumentError unless project_id
+        
+        offset_and_limit = ''
+        if options[:offset] 
+          offset_and_limit += ( '&wfspstart=' + options[:offset].to_s )
+        end
+        if options[:limit]
+          offset_and_limit += ( '&wfsplimit=' + options[:limit].to_s )
+        end
+
+        response = FontsDotCom::Request.fire({
+          message:  "/rest/json/Fonts/?wfspid=#{project_id}#{offset_and_limit}",
+          method:   :get
+        })
+      end
+      
+      def add_font(options)
+        project_id  = options[:project_id]
+        font_id     = options[:font_id]
+        publish     = options.has_key?(:publish) ? options[:publish] : true
+
+        raise ArgumentError unless project_id && font_id
+        
+        data = {
+          wfsfid: font_id
+        }
+
+        response = FontsDotCom::Request.fire({
+          message:  "/rest/json/Fonts/?wfspid=#{project_id}",
+          method:   :post,
+          data:     data
+        })
+      end
+      
+      
+      
+      ###
+      # 
+      # Selectors
+      #
+      ###
+
+      # https://www.fonts.com/web-fonts/developers/api/list-selectors
+      def list_selectors(project_id, options={})
+        # `project_id` should be fonts.com's project ID (returned as
+        # `ProjectKey` by the API.)
+        raise ArgumentError unless project_id
+        
+        offset_and_limit = ''
+        if options[:offset] 
+          offset_and_limit += ( '&wfspstart=' + options[:offset].to_s )
+        end
+        if options[:limit]
+          offset_and_limit += ( '&wfsplimit=' + options[:limit].to_s )
+        end
+
+        response = FontsDotCom::Request.fire({
+          message:  "/rest/json/Selectors/?wfspid=#{project_id}#{offset_and_limit}",
+          method:   :get
+        })
+      end
+      
+      
+      ###
+      # 
+      # Domains
+      #
+      ###
+
+      # https://www.fonts.com/web-fonts/developers/api/list-domains
+      def list_domains(project_id, options={})
+        # `project_id` should be fonts.com's project ID (returned as
+        # `ProjectKey` by the API.)
+        raise ArgumentError unless project_id
+        
+        offset_and_limit = ''
+        if options[:offset] 
+          offset_and_limit += ( '&wfspstart=' + options[:offset].to_s )
+        end
+        if options[:limit]
+          offset_and_limit += ( '&wfsplimit=' + options[:limit].to_s )
+        end
+
+        response = FontsDotCom::Request.fire({
+          message:  "/rest/json/Domains/?wfspid=#{project_id}#{offset_and_limit}",
+          method:   :get
+        })
+      end
+   
+      # https://www.fonts.com/web-fonts/developers/api/add-domain
+      def add_domain(options)
+        project_id  = options[:project_id]
+        domain_name = options[:domain_name]
+        publish     = options.has_key?(:publish) ? options[:publish] : true
+
+        raise ArgumentError unless project_id && domain_name
+        
+        path  = "/rest/json/Domains/?wfspid=#{project_id}"
+        #path += '&wfsnopublish=1' unless publish
+        
+        data = {
+          wfsdomain_name: domain_name
+        }
+
+        response = FontsDotCom::Request.fire({
+          message:  path,
+          method:   :post,
+          data:     data
+        })
+      end
+      
+      
+      
+      ###
+      # 
+      # Publish
+      #
+      ###
+
+      # https://www.fonts.com/web-fonts/developers/api/publish
+      def publish
+        response = FontsDotCom::Request.fire({
+          message:  "/rest/json/Publish/",
+          method:   :get
+        })
+      end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    end
+  end
+end

data/lib/fonts_dot_com/auth_param.rb

@@ -0,0 +1,43 @@
+require 'uri'
+require 'openssl'
+require 'base64'
+
+module FontsDotCom
+  class AuthParam
+    # Returns properly-encoded md5 HMAC per
+    # http://www.fonts.com/web-fonts/developers/api/authorizationparameter
+   
+    def self.create(message)
+      self.new(message).compute
+    end
+  
+    attr_accessor :message, :param, :digest, :hasher, :concatenation, :hash, :hash64, :auth
+    
+    def initialize(message)
+      @message = message
+      @digest = OpenSSL::Digest.new('md5')
+      @hasher = OpenSSL::HMAC.new(priv_key, @digest)
+      @concatenation = "#{pub_key}|#{message}"
+    end
+
+    def compute
+      hasher.update(concatenation)
+      @hash = hasher.to_s
+      
+      # Convert hash from hex to base 64
+      @hash64 = [[@hash].pack("H*")].pack("m0")
+      @auth   = "#{pub_key}:#{@hash64}"
+      @param  = URI.encode(@auth)
+      
+      return @param
+    end
+
+    def pub_key
+      pub_key = FontsDotCom::Config.public_key
+    end
+
+    def priv_key
+      priv_key = FontsDotCom::Config.private_key
+    end
+  end
+end

data/lib/fonts_dot_com/config.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+
+module FontsDotCom
+  module Config
+
+    class << self
+     
+      attr_accessor :public_key, :private_key, :api_key
+      
+      def configure
+        yield self
+      end
+
+      def app_key
+        api_key
+      end
+    end
+  end
+end

data/lib/fonts_dot_com/request.rb

@@ -0,0 +1,103 @@
+require 'net/http'
+
+module FontsDotCom
+  class Request
+
+    def self.fire(options)
+      self.new(options).run
+    end
+   
+    attr_accessor :request, 
+                  :message, 
+                  :method, 
+                  :uri, 
+                  :query_params, 
+                  :data_params, 
+                  :original_options
+    
+    def initialize(options={})
+      set_up(options)
+    end
+
+    def set_up(options={})
+      @original_options = options
+      
+      # Process options
+
+      if options.is_a? String
+        @message = options
+      else
+        @message      = options[:message]
+        @method       = ( options[:method] || :get).to_sym
+        @data_params  = options[:data]
+        @query_params = options[:query]
+      end
+
+      raise ArgumentError unless allowed_http_verbs.include? @method
+
+
+
+      @uri = URI(base + message)
+
+      case method
+      when :get
+        @request = Net::HTTP::Get.new(uri)
+      when :post
+        @request = Net::HTTP::Post.new(uri)
+      when :put
+        @request = Net::HTTP::Put.new(uri)
+      when :delete
+        @request = Net::HTTP::Delete.new(uri)
+      end
+      
+      # Compute md5 HMAC for request
+      @auth_param = FontsDotCom::AuthParam.create @message
+      
+      # Set request headers
+      @request['authorization'] = @auth_param
+      @request['appKey'] = FontsDotCom::Config.app_key
+
+      # Set form data
+      @request.set_form_data(data_params) if data_params
+      
+      # Set query params 
+      # TODO
+
+      @request
+    end
+
+    def run(attempted_authentication=false)
+      res = Net::HTTP.start(uri.hostname, uri.port) {|http| http.request(@request) }
+
+      @response = FontsDotCom::Response.new(res)
+
+      return @response
+    end
+
+    private
+    
+    def base
+      "#{protocol}://api.fonts.com"
+    end
+    
+    def base_uri
+      "#{protocol}://api.fonts.com/rest/#{format}/"
+    end
+    
+    def config
+      @config ||= FontsDotCom.config
+    end
+
+    def protocol
+      'http' #TODO make settable?
+    end
+    
+    def format
+      'json' #TODO make settable?
+    end
+
+    def allowed_http_verbs
+      [:get, :post, :put, :delete]
+    end
+  end
+end

data/lib/fonts_dot_com/response.rb

@@ -0,0 +1,52 @@
+require 'json'
+
+module FontsDotCom
+  class Response
+
+    class ApiError < StandardError 
+      attr :response
+      
+      def initialize(response)
+        @response = response
+      end
+
+      class AuthenticationFailed; end
+    end
+
+    attr_accessor :original_response_object, :body, :code
+
+    def initialize(response, options={})
+      @original_response_object = response
+
+      json  = JSON.parse(response.body)
+
+      @body = json
+      @code = response.code
+
+      raise error.new(self) if returned_error
+    end
+
+    def status
+      raise 'TODO'
+    end
+
+    def session_key
+      records[0].fetch(:sessionKey) 
+    end
+
+    def returned_error
+      code[0].to_i > 2
+    end
+
+    def error
+      # TODO
+      ApiError
+    end
+
+    private
+
+    def authentication_error_code
+      raise 'todo'
+    end
+  end
+end

data/lib/fonts_dot_com/version.rb

@@ -0,0 +1,3 @@
+module FontsDotCom
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: fonts_dot_com
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- John Friel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: Gem for making requests to fonts.com API.
+email:
+- john@johnfriel.net
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fonts_dot_com.gemspec
+- lib/fonts_dot_com.rb
+- lib/fonts_dot_com/api.rb
+- lib/fonts_dot_com/auth_param.rb
+- lib/fonts_dot_com/config.rb
+- lib/fonts_dot_com/request.rb
+- lib/fonts_dot_com/response.rb
+- lib/fonts_dot_com/version.rb
+homepage: https://github.com/Postcontext/fonts_dot_com
+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.5.1
+signing_key: 
+specification_version: 4
+summary: For making requests to fonts.com API.
+test_files: []