awesomekit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa7ab5dc29d8d9f285b380e00960d32c61bb26bc
+  data.tar.gz: 4f64ed4474f314e6087f6e4fbb220d515ee9bd71
+SHA512:
+  metadata.gz: 159a13a507dc51481402214e5588446cd0fe2f6c5ffcd229735d271a63736014018636f0bf2be4cd22c317454eac07e35f76e53fe4d7d5289ced052415151d63
+  data.tar.gz: f0ebc1288b930eafb1576c7168f2bdae1435d715fcd69e232d14bc2616792ad8231dd89d4786e989aa2a65ca6749034a8e07aa724e9d9acd154555d98dce31a5

data/bin/awesomekit

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'awesomekit'
+
+Awesomekit::CLI.start(ARGV)

data/lib/awesomekit.rb

@@ -0,0 +1,10 @@
+module Awesomekit
+  VERSION = '0.0.1'
+  NAME = 'awesomekit'
+end
+
+require 'formatador'
+
+require 'awesomekit/authenticator'
+require 'awesomekit/client'
+require 'awesomekit/cli'

data/lib/awesomekit/authenticator.rb

@@ -0,0 +1,39 @@
+module Awesomekit
+  class Authenticator
+    CONFIG_FILE = '.typekit'
+
+    # PUBLIC: Return the current saved api_key
+    # If no key exists, prompt user for key
+    def self.api_key
+      if File.exist?(config)
+        File.open(config, 'r').gets
+      else
+        prompt_user_for_key
+      end
+    end
+
+    # PUBLIC: Delete any existing api_key config file
+    def self.clear_api_key
+      File.unlink(config) if File.exist?(config)
+    end
+
+    private
+
+    def self.prompt_user_for_key
+      Formatador.display('[yellow]Please enter your Adobe Typekit API key: [/]')
+      api_key = STDIN.gets.chomp
+      save_key_to_config(api_key)
+      api_key
+    end
+
+    def self.save_key_to_config(api_key)
+      File.open(config, 'w') do |file|
+        file.write(api_key)
+      end
+    end
+
+    def self.config
+      File.join(Dir.home, CONFIG_FILE)
+    end
+  end
+end

data/lib/awesomekit/cli.rb

@@ -0,0 +1,83 @@
+require 'thor'
+
+module Awesomekit
+  class CLI < Thor
+    include Thor::Actions
+
+    desc 'logout', 'Remove your Adobe Typekit API key'
+    def logout
+      Awesomekit::Authenticator.clear_api_key
+      Formatador.display_line('[yellow]Successfully logged out[/]')
+    end
+
+    desc 'list', 'List available kits'
+    method_option :verbose, type: :boolean
+    method_option :published, default: false, type: :boolean, :aliases => "-p",
+      description: 'Flag to return information on the current
+      published version of the kit. Defaults to false, or draft kit version.'
+    def list
+      kits = typekit_client.get_kits
+      return not_found if kits.empty?
+
+      display_kits(kits)
+
+      if options[:verbose]
+        kits.each do |kit|
+          kit = typekit_client.get_kit(kit['id'], options[:published])
+          display_kit_detail(kit)
+        end
+      end
+    end
+
+    desc 'show', 'Display a specific kit'
+    method_option :id, type: :string, required: true
+    method_option :published, default: false, type: :boolean, :aliases => "-p",
+      description: 'Flag to return information on the current
+      published version of the kit. Defaults to false, or draft kit version.'
+    def show
+      kit = typekit_client.get_kit(options[:id], options[:published])
+
+      display_kit_detail(kit)
+    end
+
+    private
+
+    def display_kits(kits)
+      Formatador.display_line("[bold]Your Kits:[/]")
+      Formatador.display_table(kits)
+    end
+
+    def display_kit_detail(kit)
+      Formatador.display_line("[blue]Kit: #{kit['name']}[/]")
+      kit_data = [{
+        id: kit['id'],
+        domains: kit['domains'].join(','),
+        analytics: kit['analytics'].to_s
+      }]
+      Formatador.display_table(kit_data, [:id, :domains, :analytics])
+
+      Formatador.display_line("[bold]#{kit['name']} Families:[/]")
+      kit['families'].each do |family|
+        display_family_detail(family)
+      end
+    end
+
+    def display_family_detail(family)
+      family_data = [{
+        name: family['name'],
+        id: family['id'],
+        slug: family['slug'],
+        css_names: family['css_names'].join(',')
+      }]
+      Formatador.display_table(family_data, [:name, :id, :slug, :css_names])
+    end
+
+    def not_found
+      Formatador.display_line('[red]No kits found[/]')
+    end
+
+    def typekit_client
+      @client ||= Awesomekit::Client.new(Awesomekit::Authenticator.api_key)
+    end
+  end
+end

data/lib/awesomekit/client.rb

@@ -0,0 +1,61 @@
+require 'httparty'
+
+module Awesomekit
+  class Client
+    include HTTParty
+
+    base_uri 'https://typekit.com/api/v1/json'
+
+    def initialize(api_key)
+      self.class.headers('X-Typekit-Token' => api_key)
+    end
+
+    # PUBLIC: Returns a list of kits owned by the authenticating user
+    # Endpoint reference: https://typekit.com/docs/api/v1/:format/kits
+    def get_kits
+      response = self.class.get("/kits")
+
+      process_errors(response)
+
+      response['kits']
+    end
+
+    # PUBLIC: Returns information about a kit found by kit_id
+    # Endpoint reference: https://typekit.com/docs/api/v1/:format/kits/:kit
+    #
+    # published=false returns the default, current draft version of the kit
+    # published=true returns the current published version of a kit
+    def get_kit(kit_id, published=false)
+      if published
+        response = self.class.get("/kits/#{kit_id}/published")
+      else
+        response = self.class.get("/kits/#{kit_id}")
+      end
+
+      process_errors(response)
+
+      response['kit']
+    end
+
+    private
+
+    # PRIVATE: Display any error messages returned by Typekit.
+    #
+    # Automatically removes an invalid api_key if error is a 401 not authorized,
+    # so the user will be prompted to enter a new key on their next request.
+    def process_errors(response)
+      if response['errors']
+        errors = '[red]The server responded with the following error(s):[/] '
+        errors << response['errors'].join(',')
+
+        if errors.include?('Not authorized')
+          Awesomekit::Authenticator.clear_api_key
+        end
+
+        Formatador.display_line(errors)
+
+        exit
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: awesomekit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Liz Hubertz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+description: Possibly the most "Awesome" CLI for Typekit Ever
+email: liz.hubertz@gmail.com
+executables:
+- awesomekit
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/awesomekit
+- lib/awesomekit.rb
+- lib/awesomekit/authenticator.rb
+- lib/awesomekit/cli.rb
+- lib/awesomekit/client.rb
+homepage: https://github.com/lizhubertz/awesomekit
+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.6.2
+signing_key: 
+specification_version: 4
+summary: Command Line Interface for interacting with the Typekit API
+test_files: []