faceapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6b57f4675e25c6bcd9a57789bd6059f52cd36fe
+  data.tar.gz: 5f2249a23cdafc983f95417b01623b9ccb697f8a
+SHA512:
+  metadata.gz: 5dc081794102567ce12a3634dd2699c80af525a442f8cf66c1c9aad0917a57a89be29a3d6500b39e9924db532a6ec2125744cbd3375d7d125dd8b3dfe98bd427
+  data.tar.gz: 7c617965779af62386f0c3a915a5cf3cb48556b0423656ee60279f0ce8466ac5791abc5fabc936f1cdf9887161e18b1c2988cee9846722268a1d939bd69b562f

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Igor Yamolov
+
+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 @@
+# Faceapp
+
+Faceapp is neural-network face manipulation application for smartphones.
+
+https://play.google.com/store/apps/details?id=io.faceapp&hl=ru
+https://itunes.apple.com/us/app/faceapp-free-neural-face-transformations/id1180884341
+
+This gem provides command-line utility and Ruby library to utilize Faceapp API without using smartphone application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faceapp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faceapp
+
+## Usage
+
+### Commandline utility
+
+```bash
+faceapp [options] <filter> <input> [ouput]
+
+  <filter> - Faceapp filter name
+    Possible values: smile, smile_2, hot, old, young, female, male
+
+  <input> - Input file name
+    Use '-' for STDIN
+
+  [output] - Optinal, output file name
+    Do not specify or use '-' for STDOUT
+
+  Options:
+    --help - Display this message
+    --cropped[=true|false] - Crop output image to face region. Enabled by default.
+    --api_host=<api_host> - Faceapp API host
+    --device_id=<device_id> - DeviceId for Faceapp
+    --user_agent=<user_agent> - User-Agent header for Faceapp API requests
+    --silent - Keep quiet, it will override `debug`
+    --debug - Print HTTP requests/responses to STDERR.
+```
+
+**Example:**
+
+```bash
+$ faceapp female hitler.jpg adolfina.jpg
+```
+
+### Ruby library
+
+```ruby
+require 'faceapp'
+
+client = Faceapp::Client.new
+
+file = File.open('hitler.jpg', 'rb')
+filter = 'female' # smile, smile_2, hot, old, young, male
+
+# File could be String or IO
+
+code = client.upload_photo(file)
+# => "2017blablabla"
+
+# By default it will return StringIO
+result = client.apply_filter(code, filter)
+# => StringIO
+
+output = File.open('output.jpg', 'wb')
+
+# Third argument might be an IO object
+result = client.apply_filter(code, filter, output)
+# => File
+
+# Or you may specify block, it will receive response chunks
+client.apply_filter(code, filter) do |chunk, cursor, total|
+    # chunk is String
+    puts chunk.bytesize
+    # render fancy progress bar
+end
+# => 100500 # Returns total bytes count
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/faceapp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'faceapp/cli'
+
+Faceapp::CLI.new(ARGV).run!

data/faceapp.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'faceapp'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Igor Yamolov']
+  spec.email         = ['clouster@yandex.ru']
+
+  spec.summary       = 'Faceapp API wrapper'
+  spec.description   = 'Simple Ruby wrapper for Faceapp API'
+  spec.homepage      = 'http://github.com/t3hk0d3/faceapp'
+  spec.license       = 'MIT'
+
+  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.add_dependency 'multipart-post', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+end

data/lib/faceapp.rb

@@ -0,0 +1,7 @@
+module Faceapp
+  require_relative 'faceapp/client'
+
+  KNOWN_FILTERS = %w(smile smile_2 hot old young female male)
+
+  class RequestError < StandardError; end
+end

data/lib/faceapp/cli.rb

@@ -0,0 +1,143 @@
+require 'logger'
+require 'faceapp'
+
+module Faceapp
+  class CLI
+    attr_reader :params, :options, :debug, :silent
+
+    OPTION_REGEXP = /\A--(?<name>[^=]+)(?:=(?<value>.+))?\Z/
+
+    PARAMS = [:filter, :input, :output].freeze
+
+    def initialize(args)
+      @params, @options = parse_arguments(args)
+    end
+
+    def run!
+      print_usage if params.empty? || options[:help]
+
+      options[:logger] = Logger.new(STDERR) if debug?
+
+      filter = params[:filter]
+      input = parse_input(params[:input])
+      output = parse_output(params[:output])
+
+      client = Faceapp::Client.new(options)
+
+      code = client.upload_photo(input)
+
+      info "Successfuly uploaded input photo. Result code = #{code}"
+      info "Applying filter '#{filter}'"
+
+      client.apply_filter(code, filter, output)
+
+      info 'Done.'
+    rescue => e
+      info "Error: #{e.message}"
+      exit(-1)
+    ensure
+      input.close if input.is_a?(File)
+      output.close if output.is_a?(File)
+    end
+
+    def print_usage
+      info <<TEXT
+faceapp [options] <filter> <input> [ouput]
+
+  <filter> - Faceapp filter name
+    Possible values: #{Faceapp::KNOWN_FILTERS.join(', ')}
+
+  <input> - Input file name
+    Use '-' for STDIN
+
+  [output] - Optinal, output file name
+    Do not specify or use '-' for STDOUT
+
+  Options:
+    --help - Display this message
+    --cropped[=true|false] - Crop output image to face region. Enabled by default.
+    --api_host=<api_host> - Faceapp API host
+    --device_id=<device_id> - DeviceId for Faceapp
+    --user_agent=<user_agent> - User-Agent header for Faceapp API requests
+    --silent - Keep quiet, it will override `debug`
+    --debug - Print HTTP requests/responses to STDERR.
+
+TEXT
+      exit(-1)
+    end
+
+    private
+
+    def parse_input(input)
+      case input
+      when '-'
+        STDIN
+      when nil
+        print_usage
+      else
+        File.open(input, 'rb')
+      end
+    rescue => e
+      info "Unable to open input: #{e.message}"
+      exit(-1)
+    end
+
+    def parse_output(output)
+      case output
+      when String
+        File.open(output, 'wb')
+      else
+        STDOUT
+      end
+    rescue => e
+      info "Unable to open output: #{e.message}"
+      exit(-1)
+    end
+
+    def parse_arguments(args)
+      params = []
+      options = {}
+
+      args.each do |arg|
+        match = OPTION_REGEXP.match(arg)
+
+        if match
+          options[match[:name].to_sym] = parse_option(match[:value])
+        else
+          params << arg
+        end
+      end
+
+      params = PARAMS.zip(params).to_h
+
+      [params, options]
+    end
+
+    def parse_option(value)
+      case value
+      when String
+        value
+      when 'false', '0'
+        false
+      else
+        true
+      end
+    end
+
+    def debug(text)
+      STDERR.puts(text) if debug?
+    end
+
+    def info(text)
+      STDERR.puts(text) unless silent?
+    end
+
+    def debug?
+      options[:debug] && !silent?
+    end
+
+    def silent?
+      options[:silent]
+    end
+  end
+end

data/lib/faceapp/client.rb

@@ -0,0 +1,135 @@
+require 'uri'
+require 'json'
+require 'openssl'
+require 'net/http'
+require 'net/http/post/multipart'
+
+module Faceapp
+  class Client
+    DEFAULT_API_HOST = 'https://node-01.faceapp.io'.freeze
+    DEFAULT_USER_AGENT = 'FaceApp/1.0.229 (Linux; Android 4.4)'.freeze
+
+    DEVICE_ID_LENGTH = 8
+    DEVICE_ID_LETTERS = ('a'..'z').to_a.freeze
+
+    KNOWN_FACEAPP_ERRORS = {
+      'bad_filter_id' => 'Unknown filter'
+    }.freeze
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+
+      options[:api_host]    ||= DEFAULT_API_HOST
+      options[:user_agent]  ||= DEFAULT_USER_AGENT
+      options[:device_id]   ||= generate_device_id
+
+      options[:headers] = {
+        'User-Agent' => options[:user_agent],
+        'X-FaceApp-DeviceID' => options[:device_id]
+      }.merge!(options[:headers] || {})
+    end
+
+    def upload_photo(photo)
+      photo_io = UploadIO.new(photo, 'image/jpeg', 'image.jpg')
+
+      request =
+        Net::HTTP::Post::Multipart.new '/api/v2.3/photos',
+                                       { 'file' => photo_io },
+                                       options[:headers]
+
+      response = http.request(request)
+
+      body = JSON.parse(response.body)
+
+      unless response.is_a?(Net::HTTPSuccess)
+        if body.is_a?(Hash) && body['err']
+          error = body['err']
+
+          error_message = "(#{error['code']}) #{error['desc']}"
+        else
+          error_message = response.body.to_s
+        end
+
+        raise Faceapp::RequestError, error_message
+      end
+
+      body['code']
+    end
+
+    def apply_filter(photo_code, filter, io = nil, &block)
+      cropped = options.fetch(:cropped, true) ? 1 : 0
+
+      url = "/api/v2.3/photos/#{photo_code}/filters/#{filter}?cropped=#{cropped}"
+
+      request = Net::HTTP::Get.new(url, options[:headers])
+
+      dest = io ? io : StringIO.new
+
+      http.request(request) do |response|
+        unless response.is_a?(Net::HTTPSuccess)
+          error_code =
+            if response['x-faceapp-errorcode']
+              response['x-faceapp-errorcode']
+            elsif response.code == '404'
+              'bad_photo_code'
+            else
+              'unknown_error'
+            end
+
+          error_message = KNOWN_FACEAPP_ERRORS.fetch(error_code, error_code)
+          error_message = format(error_message, photo_code, filter)
+
+          raise Faceapp::RequestError, error_message
+        end
+
+        dest = handler_filter_response(response, dest, &block)
+      end
+
+      dest.rewind if !io && !block_given?
+
+      dest
+    end
+
+    private
+
+    def http
+      @http ||= begin
+        uri = URI.parse(options[:api_host])
+
+        http = Net::HTTP.new(uri.hostname, uri.port)
+
+        http.set_debug_output(options[:logger]) if options[:logger]
+
+        if uri.scheme == 'https'
+          http.use_ssl = { verify_mode: OpenSSL::SSL::VERIFY_PEER }
+        end
+
+        http
+      end
+    end
+
+    def handler_filter_response(response, dest)
+      if block_given?
+        cursor = 0
+        total = response.content_length
+
+        response.read_body do |chunk|
+          yield chunk, cursor, total
+          cursor += chunk.size
+        end
+
+        total # return total size
+      else
+        response.read_body(dest)
+
+        dest
+      end
+    end
+
+    def generate_device_id(length = DEVICE_ID_LENGTH)
+      Array.new(length) { DEVICE_ID_LETTERS.sample }.join
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: faceapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Yamolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple Ruby wrapper for Faceapp API
+email:
+- clouster@yandex.ru
+executables:
+- faceapp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/faceapp
+- faceapp.gemspec
+- lib/faceapp.rb
+- lib/faceapp/cli.rb
+- lib/faceapp/client.rb
+homepage: http://github.com/t3hk0d3/faceapp
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Faceapp API wrapper
+test_files: []