fontabulous 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e75ce82c42a59cd957914e760defe3e6fe7cfc
-  data.tar.gz: c9c7738242ffcced9c365c51b33b153929420f1b
+  metadata.gz: 9e8037826c668bff4f29f3e40d69f109fb39c310
+  data.tar.gz: a5a61a18c634478ac257e4acfdb7bb24623dde41
 SHA512:
-  metadata.gz: 316f660853e56106940e219903d0f6855be386a67f7ad85736cb657d46096b7a6f06a852296142fa616291eeccef6705b8d82f16ca3291e37e261bb1281ca579
-  data.tar.gz: d06b08c93da12ee0500a13b88c18d69d11cde8d19c141c6bc8f5f64e528b411892b912aacd0cbc87ef67102f41b78694bb0b043a3ef887a3d18bf167609ae6ff
+  metadata.gz: 69b79637f97bbd1424367b27dc2ad96f54c13105ca8a6995938816abb914d8c0cff2e8917706843bf06fa85d194d0678b5deedaf677e656c3192bf425de15624
+  data.tar.gz: c9dcdd496d7615ff84559518eb9a415981b2d0e3ea9fa4af823f5e2a94ade5d7ebcb238bfa848dac9c7ff4857431cb87d9a9311c52415de9004a601114601c75

data/.gitignore

@@ -0,0 +1,193 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+# Created by https://www.gitignore.io/api/ruby,macos,rubymine,sublimetext
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### RubyMine ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Ruby plugin and RubyMine
+/.rakeTasks
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### RubyMine Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### SublimeText ###
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+
+# End of https://www.gitignore.io/api/ruby,macos,rubymine,sublimetext

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 120
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 50

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fontabulous.gemspec
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# Fontabulous
+
+[![Build Status](https://travis-ci.org/v1nayv/fontabulous.svg?branch=master)](https://travis-ci.org/v1nayv/fontabulous)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/4b3ad8039c9df03695de/maintainability)](https://codeclimate.com/github/v1nayv/fontabulous/maintainability)
+
+
+Command line Ruby application to access information about Typekit kits using [Adobe Typekit's public API](https://typekit.com/docs/api).
+
+## Installation
+
+    $ gem install fontabulous
+
+## Setup
+
+Create a `.fontabulous` config file which contains configuration items to your typekit account. Note that this config file should be created in the home directory.
+
+If this config file is not created you will be asked for the token every time you run a command.
+
+Here is a sample file
+
+    typekit_auth_token: df0c9e6b07bf7695adc44cd302b474a9fa424b49
+    base_uri: https://typekit.com
+
+**typekit_auth_token** - Is the token generated from your account. <br>
+**base_uri (optional)** - is the base_uri to access Adobes typekit public API. If this is not defined the base uri will default to https://typekit.com
+## Usage
+
+### Available commands
+
+* `foab kits`  - Lists kits owned by the authenticating user.
+* `foab kit draft <id>` - Shows draft version of the kit based on the id.
+* `foab kit published <id>` - Shows published version of the kit based on the id.
+* `foab help` - Shows available commands.
+
+## Development
+
+* git clone the repo
+* `bundle` to install dependencies
+* Use `bundle exec bin/foab <command>` to run the commands during development.
+
+### Tests
+
+* Run `rspec` to run tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/v1nayv/fontabulous.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fontabulous'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/foab

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fontabulous'
+
+Fontabulous::FoabCli.start(ARGV)

data/bin/setup

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

data/fontabulous.gemspec

@@ -0,0 +1,37 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fontabulous/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fontabulous'
+  spec.version       = Fontabulous::VERSION
+  spec.authors       = ['Vinay Vasudevamurthy']
+  spec.email         = ['vinay.vasudevamurthy@cerner.com']
+
+  spec.summary       = 'Ruby gem to retrieve retrieve Adobe Typekit information.'
+  spec.description   = 'Ruby gem to retrieve retrieve Adobe Typekit information.'
+  spec.homepage      = 'https://github.com/v1nayv/fontabulous'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.4'
+
+  spec.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'highline', '~> 1.7'
+  spec.add_dependency 'httparty', '~> 0.15'
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug', '~> 3.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+end

data/lib/fontabulous.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'fontabulous/version'
+require 'fontabulous/cli'
+require 'active_support'
+require 'active_support/core_ext'
+
+##
+# Contains code to access Adobe typekit information.
+module Fontabulous
+end

data/lib/fontabulous/cli.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'fontabulous/retrievers/kit'
+require 'fontabulous/templates/console_output_template'
+require 'fontabulous/typekit_config'
+
+module Fontabulous
+  ##
+  # This is a class that lets you retreive information about a kit from command line.
+  class Kit < Thor
+    desc 'draft <id>', 'Shows the current draft version of the kit'
+    def draft(id)
+      config = Fontabulous::TypekitConfig.instance
+      kit = Fontabulous::Retrievers::Kit.new(base_uri: config.base_uri, auth_token: config.auth_token)
+
+      header = "The current draft version of Kit: #{id}"
+      output_template = Fontabulous::Templates::ConsoleOutputTemplate.new(header, kit.draft(id: id).data)
+      output_template.print
+    end
+
+    desc 'published <id>', 'Shows the current published version of the kit'
+    def published(id)
+      config = Fontabulous::TypekitConfig.instance
+      kit = Fontabulous::Retrievers::Kit.new(base_uri: config.base_uri, auth_token: config.auth_token)
+
+      header = "The current published version of Kit: #{id}"
+      output_template = Fontabulous::Templates::ConsoleOutputTemplate.new(header, kit.published(id: id).data)
+      output_template.print
+    end
+  end
+
+  ##
+  # This is a class that lets you retreive information about Adobe Typekits from command line.
+  class FoabCli < Thor
+    desc 'kits', 'Lists all the kits under your account.'
+    def kits
+      config = Fontabulous::TypekitConfig.instance
+      kit = Fontabulous::Retrievers::Kit.new(base_uri: config.base_uri, auth_token: config.auth_token)
+
+      header = 'Information about your kits are as follows'
+      output_template = Fontabulous::Templates::ConsoleOutputTemplate.new(header, kit.all.data)
+      output_template.print
+    end
+
+    desc 'kit SUBCOMMAND ...ARGS', 'Show details about the kit. `foab kit help` for subcommand help.'
+    subcommand 'kit', Fontabulous::Kit
+  end
+end

data/lib/fontabulous/retrievers/kit.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'fontabulous/retrievers/typekit_base'
+
+module Fontabulous
+  module Retrievers
+    ##
+    # This is a retriever class which retrieves Adobe Typekit information from the
+    # typekit public api https://typekit.com/docs/api/v1/:format/kits
+    class Kit < TypekitBase
+      def all
+        response = self.class.get('/api/v1/json/kits', options)
+        Response.new(response.code, response.parsed_response)
+      end
+
+      def draft(id:)
+        response = self.class.get("/api/v1/json/kits/#{id}", options)
+        Response.new(response.code, response.parsed_response)
+      end
+
+      def published(id:)
+        response = self.class.get("/api/v1/json/kits/#{id}/published", options)
+        Response.new(response.code, response.parsed_response)
+      end
+    end
+  end
+end

data/lib/fontabulous/retrievers/typekit_base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Fontabulous
+  module Retrievers
+    ##
+    # This is a base class which is responsible for setting up config to access Adobe Typekit public api.
+    class TypekitBase
+      include HTTParty
+
+      attr_reader :options
+
+      def initialize(base_uri:, auth_token:)
+        self.class.base_uri base_uri
+        @options = { headers: { 'X-Typekit-Token' => auth_token } }
+      end
+    end
+
+    Response = Struct.new(:code, :data)
+  end
+end

data/lib/fontabulous/templates/console_output_template.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'fontabulous/templates/output_template'
+require 'yaml'
+
+module Fontabulous
+  module Templates
+    ##
+    # This is class responsible for writing information out on the console.
+    class ConsoleOutputTemplate < OutputTemplate
+      def initialize(header, hash_data)
+        @header = header
+        @hash_data = hash_data
+      end
+
+      def header
+        puts @header
+      end
+
+      def separator
+        puts '-' * 50
+      end
+
+      def body
+        puts @hash_data.to_yaml(indentation: 4)
+      end
+    end
+  end
+end

data/lib/fontabulous/templates/output_template.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Fontabulous
+  module Templates
+    ##
+    # This is a template for writing out information. This class should to be inherited to get a
+    #  custom output.
+    class OutputTemplate
+      def print
+        separator
+        header
+        separator
+        body
+        separator
+      end
+
+      def separator
+        raise 'Not implemented'
+      end
+
+      def header
+        raise 'Not implemented'
+      end
+
+      def body
+        raise 'Not implemented'
+      end
+    end
+  end
+end

data/lib/fontabulous/typekit_config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'highline/import'
+
+module Fontabulous
+  ##
+  # Singleton class to acess users configuration.
+  class TypekitConfig
+    include Singleton
+
+    def initialize
+      user_config_path = File.expand_path('~/.fontabulous')
+
+      @config = begin
+        default_hash = { base_uri: 'https://typekit.com' }
+        if File.exist?(user_config_path)
+          default_hash.merge!(YAML.load_file(user_config_path).symbolize_keys)
+        else
+          puts 'Consider creating .fontabulous config file in your home directory'
+        end
+
+        default_hash.freeze
+      end
+    end
+
+    def auth_token
+      return @config[:typekit_auth_token] if @config[:typekit_auth_token].present?
+      ask('Enter Typekit Auth token:')
+    end
+
+    def base_uri
+      @config[:base_uri]
+    end
+  end
+end

data/lib/fontabulous/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Fontabulous
+  VERSION = '0.2.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fontabulous
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vinay Vasudevamurthy
@@ -139,10 +139,33 @@ dependencies:
 description: Ruby gem to retrieve retrieve Adobe Typekit information.
 email:
 - vinay.vasudevamurthy@cerner.com
-executables: []
+executables:
+- console
+- foab
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/foab
+- bin/setup
+- fontabulous.gemspec
+- lib/fontabulous.rb
+- lib/fontabulous/cli.rb
+- lib/fontabulous/retrievers/kit.rb
+- lib/fontabulous/retrievers/typekit_base.rb
+- lib/fontabulous/templates/console_output_template.rb
+- lib/fontabulous/templates/output_template.rb
+- lib/fontabulous/typekit_config.rb
+- lib/fontabulous/version.rb
 homepage: https://github.com/v1nayv/fontabulous
 licenses: []
 metadata: {}
@@ -152,9 +175,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="