percy-client 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8e5850fd7fe46854b7a81f08062535f772ee968
-  data.tar.gz: e162bc2630ecd6cc3098f12a336dc96e4136b2d9
+  metadata.gz: a82de11a13b2a403586e6e50adc8afeda0bc32e1
+  data.tar.gz: 79849f84e7c401e6e310f4208a6db745f1f3e1e1
 SHA512:
-  metadata.gz: 6d1ca813877e312dd255edba8c8399ccf20450174b031ea83092c7bfbe19be91bf48c1af92a0d507543881cfc5b48c89e3427ad312a13c3fc89666e5ae66a985
-  data.tar.gz: 38b7ab396a28e824973ba57178b43635e145bab1475afd1e4ea98cfbb81d849d1aa654920c8a35408c91845d5ddc4abd2ad100d9a6a6f667ca2e7021aa80773d
+  metadata.gz: 33a045cccc8e025003506b6a0d1a7504bf1bec9d3b718dc77b6fde44eb829a183e77c3471b085796b136eb0a1a9b48c928895ef36ab01430b65e1c7711af4f05
+  data.tar.gz: 223a6d07e57d67d95248d1bd3d385b396663d6435e6f8cdfbb025cca4699fa77ad9f016195f21b87f008869f782d53d97161c85a5240e93549af6fca2d81c67a

data/.gitignore

@@ -1,35 +1,14 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/Gemfile.lock
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/test/tmp/
-/test/version_tmp/
 /tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.rbc
+mkmf.log
 .DS_Store
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.1
+  - 2.2.2
+  - ruby-head
+script: bundle exec rspec

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in perceptual.gemspec
+# Specify your gem's dependencies in percy-client.gemspec
 gemspec
+
+gem 'guard-rspec', require: false

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) 2015 Perceptual Inc.
 
-Copyright (c) 2015 Mike Fotinakis
+The MIT License (MIT)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,2 +1,34 @@
-# perceptual-ruby
-Ruby client library for Perceptual CI
+# Percy::Client
+
+[![Build Status](https://travis-ci.org/percy/percy-client.svg?branch=master)](https://travis-ci.org/percy/percy-client)
+[![Gem Version](https://badge.fury.io/rb/percy-client.svg)](http://badge.fury.io/rb/percy-client)
+
+(in development, coming soon)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'percy-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install percy-client
+
+## Usage
+
+...
+
+## Contributing
+
+1. Fork it ( https://github.com/percy/percy-client/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

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 

data/lib/percy.rb

@@ -0,0 +1,37 @@
+require 'percy/client'
+
+module Percy
+  class << self
+    attr_accessor :access_token
+  end
+
+  def self.options
+    {
+      access_token: access_token,
+    }
+  end
+
+  # API client based on configured options.
+  #
+  # @return [Percy::Client] API client.
+  def self.client
+    @client = Percy::Client.new(options) unless defined?(@client)
+    @client
+  end
+
+  # @private
+  def self.respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name, include_private)
+  end if RUBY_VERSION >= '1.9'
+
+  # @private
+  def self.respond_to?(method_name, include_private = false)
+    client.respond_to?(method_name, include_private) || super
+  end if RUBY_VERSION < '1.9'
+
+  def self.method_missing(method_name, *args, &block)
+    return super if !client.respond_to?(method_name)
+    client.send(method_name, *args, &block)
+  end
+  private :method_missing
+end

data/lib/percy/client.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'percy/client/connection'
+require 'percy/client/local_git'
+require 'percy/client/version'
+require 'percy/client/builds'
+require 'percy/client/snapshots'
+require 'percy/client/resources'
+
+module Percy
+  class Client
+    include Percy::Client::Connection
+    include Percy::Client::LocalGit
+    include Percy::Client::Builds
+    include Percy::Client::Snapshots
+    include Percy::Client::Resources
+
+    class Error < Exception; end
+    class ClientError < Error
+      attr_accessor :env
+      def initialize(env, *args)
+        @env = env
+        super(*args)
+      end
+    end
+
+    API_BASE_URL = ENV['PERCY_API'] || 'https://percy.io'
+    API_VERSION = ENV['PERCY_API_VERSION'] || 'v1'
+
+    attr_accessor :access_token
+
+    def initialize(options = {})
+      @access_token = options[:access_token] || ENV['PERCY_TOKEN']
+    end
+
+    def base_url
+      API_BASE_URL
+    end
+
+    def base_path
+      "/api/#{API_VERSION}"
+    end
+
+    def full_base
+      "#{base_url}#{base_path}"
+    end
+  end
+end

data/lib/percy/client/builds.rb

@@ -0,0 +1,32 @@
+module Percy
+  class Client
+    module Builds
+      def create_build(repo_slug)
+        commit = Percy.current_local_commit
+        data = {
+          'data' => {
+            'type' => 'builds',
+            'attributes' => {
+              'commit-sha' => commit[:sha],
+              'commit-branch' => commit[:branch],
+              'commit-committed-at' => commit[:committed_at],
+              'commit-author-name' => commit[:author_name],
+              'commit-author-email' => commit[:author_email],
+              'commit-committer-name' => commit[:committer_name],
+              'commit-committer-email' => commit[:committer_email],
+              'commit-message' => commit[:message],
+              'pull-request-number' => nil,
+            },
+          }
+        }
+        post("#{full_base}/repos/#{repo_slug}/builds/", data)
+      end
+
+      def finalize_build(build_id)
+        post("#{full_base}/builds/#{build_id}/finalize", {})
+      end
+    end
+  end
+end
+
+

data/lib/percy/client/connection.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+
+module Percy
+  class Client
+    module Connection
+      class FaradayNiceErrorMiddleware < Faraday::Response::Middleware
+        CLIENT_ERROR_STATUS_RANGE = 400...600
+
+        def on_complete(env)
+          case env[:status]
+          when 407
+            # Mimic the behavior that we get with proxy requests with HTTPS.
+            raise Faraday::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
+          when CLIENT_ERROR_STATUS_RANGE
+            raise Percy::Client::ClientError.new(
+              env, "Got #{env.status} (#{env.method.upcase} #{env.url}):\n#{env.body}")
+          end
+        end
+      end
+
+      def connection
+        return @connection if defined?(@connection)
+        @connection = Faraday.new(url: base_url) do |faraday|
+          faraday.request :token_auth, @access_token if @access_token
+
+          faraday.use Faraday::Adapter::HTTPClient
+          faraday.use Percy::Client::Connection::FaradayNiceErrorMiddleware
+        end
+        @connection
+      end
+
+      def get(path)
+        response = connection.get do |request|
+          request.url(path)
+          request.headers['Content-Type'] = 'application/vnd.api+json'
+        end
+        JSON.parse(response.body)
+      end
+
+      def post(path, data)
+        response = connection.post do |request|
+          request.url(path)
+          request.headers['Content-Type'] = 'application/vnd.api+json'
+          request.body = data.to_json
+        end
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/percy/client/local_git.rb

@@ -0,0 +1,50 @@
+module Percy
+  class Client
+    module LocalGit
+      GIT_FORMAT_LINES = [
+        'COMMIT_SHA:%H',
+        'AUTHOR_DATE:%ai',
+        'AUTHOR_NAME:%an',
+        'AUTHOR_EMAIL:%ae',
+        'COMMITTER_NAME:%an',
+        'COMMITTER_EMAIL:%ae',
+        'COMMITTER_DATE:%ai',
+        # Note: order is important, this must come last because the regex is a multiline match.
+        'COMMIT_MESSAGE:%B'
+      ].freeze
+
+      class Error < Exception; end
+      class NoLocalRepo < Exception; end
+
+      def current_local_commit
+        commit = ENV['PERCY_COMMIT'] || 'HEAD'
+        branch = ENV['PERCY_BRANCH'] || `git rev-parse --abbrev-ref HEAD`.strip
+        if branch == ''
+          raise Percy::Client::LocalGit::NoLocalRepo.new('No local git repository found.')
+        end
+
+        format = GIT_FORMAT_LINES.join('%n')  # "git show" format uses %n for newlines.
+        output = `git show --quiet #{commit} --format="#{format}"`.strip
+        data = {
+          sha: output.match(/COMMIT_SHA:(.*)/)[1],
+          branch: branch,
+          committed_at: output.match(/AUTHOR_DATE:(.*)/)[1],
+          author_name: output.match(/AUTHOR_NAME:(.*)/)[1],
+          author_email: output.match(/AUTHOR_EMAIL:(.*)/)[1],
+          committer_name: output.match(/COMMITTER_NAME:(.*)/)[1],
+          committer_email: output.match(/COMMITTER_EMAIL:(.*)/)[1],
+          message: output.match(/COMMIT_MESSAGE:(.*)/m)[1],
+        }
+      end
+
+      def current_local_repo
+        origin_url = `git config --get remote.origin.url`
+        if origin_url == ''
+          raise Percy::Client::LocalGit::NoLocalRepo.new('No local git repository found.')
+        end
+        match = origin_url.match(Regexp.new('[:/]([^/]+\/[^/]+)\.git'))
+        match[1]
+      end
+    end
+  end
+end

data/lib/percy/client/resources.rb

@@ -0,0 +1,54 @@
+require 'base64'
+require 'digest'
+
+module Percy
+  class Client
+
+    # A simple data container object used to pass data to create_snapshot.
+    class Resource
+      attr_accessor :sha
+      attr_accessor :resource_url
+      attr_accessor :is_root
+      attr_accessor :mimetype
+
+      def initialize(sha, resource_url, options = {})
+        @sha = sha
+        @resource_url = resource_url
+        @is_root = options[:is_root]
+        @mimetype = options[:mimetype]
+      end
+
+      def serialize
+        {
+          'type' => 'resources',
+          'id' => sha,
+          'resource-url' => resource_url,
+          'mimetype' => mimetype,
+          'is-root' => is_root,
+        }
+      end
+    end
+
+    module Resources
+      def upload_resource(build_id, content)
+        sha = Digest::SHA256.hexdigest(content)
+        data = {
+          'data' => {
+            'type' => 'resources',
+            'attributes' => {
+              'id' => sha,
+              'base64-content' => Base64.strict_encode64(content),
+            },
+          },
+        }
+        begin
+          post("#{full_base}/builds/#{build_id}/resources/", data)
+        rescue Percy::Client::ClientError => e
+          raise e if e.env.status != 409
+          STDERR.puts "[percy] Warning: unnecessary resource reuploaded with SHA-256: #{sha}"
+        end
+        true
+      end
+    end
+  end
+end

data/lib/percy/client/snapshots.rb

@@ -0,0 +1,22 @@
+module Percy
+  class Client
+    module Snapshots
+      def create_snapshot(build_id, resources, options = {})
+        raise ArgumentError.new('resources must be an iterable') if !resources.respond_to?(:each)
+        name = options[:name]
+        data = {
+          'data' => {
+            'type' => 'snapshots',
+            'attributes' => {
+              'name' => name,
+            },
+            'links' => {
+              'resources' => resources.map { |r| r.serialize },
+            },
+          },
+        }
+        post("#{full_base}/builds/#{build_id}/snapshots/", data)
+      end
+    end
+  end
+end