emojidex 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d4b38c501700ed3d2d7e639a8123ee9630240e8
-  data.tar.gz: 783ac24a6aef70c3f17e6b7661dfed77b8d9cb8b
+  metadata.gz: 4893c39e085f721f6888fb84899b4749ef435134
+  data.tar.gz: 10bf72c13623c7acf1c1c98fc68da7c133559a31
 SHA512:
-  metadata.gz: cab3827fa637dbc4fb034db5e5175f4e3fd9d02f0e458002e1a554aa2e555b06edd0c01e5d389ca094526089c172709dcce86c3e44be68ca71f50f42123cc55a
-  data.tar.gz: 0454eee99c8ce194e940ba3460db2a60fd0626f0ee37b0e458fdbc251384f6da1c7b93cd7068303edc610b3cb49e061fe83a6057a31ed3ae386dea9c9010d1e6
+  metadata.gz: a11b74ed96b360150373b2a37934eaeebed32452c02dbc57b045498a8c41c37efdbd0299eb91b5076ff88e221143f6cb57602e2a3b3d7400844b68f0e76628d2
+  data.tar.gz: 7033d1b7719e8b99360eef165fde88f04e7ff6c60646d12f27f513bec93471b4609453ff00897847b601dfac3b2b43cc6f4c47b783a681c49731429553f022dd

data/.gitignore

@@ -1,11 +1,12 @@
-.bundle/
-log/*.log
-pkg/
-test/dummy/db/*.sqlite3
-test/dummy/db/*.sqlite3-journal
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/.sass-cache
-.project
-.DS_Store
+*.swp
+*.swo
+*.orig
 Gemfile.lock
+*.gem
+spec/out/
+spec/support/tmpcache/
+tmp/
+.DS_Store
+.ruby-gemset
+.ruby-version
+coverage

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AsciiIdentifiers:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AccessorMethodName:
+  Enabled: false
+
+LineLength:
+  Max: 99

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - jruby-19mode
+  - rbx-2
+
+bundler_args: -j4 --without development
+
+script:
+  - bundle exec rspec
+
+addons:
+  code_climate:
+    repo_token: 4f9c56a5c9a2e99acd8e8f06491940f9174c6fd1e22236539bb2cbc2fefd0e30

data/Gemfile

@@ -1,14 +1,20 @@
-source "https://rubygems.org"
+source 'http://rubygems.org'
 
-# Declare your gem's dependencies in emojidex.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
 gemspec
 
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
+group :development do
+  gem 'rb-inotify', require: false
+  gem 'rb-fsevent', require: false
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rubocop'
+  gem 'guard-rubocop'
+  #gem 'emojidex-vectors', path: '../emojidex-vectors'
+end
 
-# To use debugger
-# gem 'debugger'
+group :test do
+  gem 'coveralls', require: false
+  gem 'rspec'
+  gem 'webmock'
+  gem 'emojidex-vectors', github: 'emojidex/emojidex-vectors'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end

data/README.md

@@ -1,8 +1,30 @@
-Emojidex for Rails
-============================
-Web scripts and libraries to use Emojidex in Rails apps.
-Includes Phantom Open Emoji for the base emoji and connects to emojidex for extended emoji.
+[![Gem Version](https://badge.fury.io/rb/emojidex.png)](http://badge.fury.io/rb/emojidex)
+[![Build Status](https://travis-ci.org/emojidex/emojidex.png)](https://travis-ci.org/emojidex/emojidex)
+[![Code Climate](https://codeclimate.com/github/emojidex/emojidex.png)](https://codeclimate.com/github/emojidex/emojidex)
+emojidex
+========
+emojidex core tools and scripts in Ruby. Provides a set of tools to utilize emojidex emoji right away in Ruby. Available as the "emojidex" gem.
 
 License
 =======
-This library is licensed under the LGPL. You may use it freely in any project or service but you must make modifications freely and openly available.
+There are three choices for licensing of emojidex libraries and assets. In each case emoji assets are Copyright Genshin Souzou Kabushiki Kaisha [Phantom Creation Inc.]. Emoji images may be used under the terms of the emojidex emoji use license. Use in digital distrobution is subject to the terms and conditions below. Emoji may not be used on commercial printed material or in any commercial physical production without a separate license.
+
+Closed or Open Source Software with emojidex service:
+-----------------------------------------------------
+When used in conjuction with the emojidex service and without disabling or obstructing features or connectivity emojidex-toolkit may be used in commercial or closed source applications. In this situation all sources are considered to be licensed under the LGPL version 3. Emoji assets are not subject to the LGPL and remain copyrighted licensed works.
+
+Closed Source software without emojidex service:
+------------------------------------------------
+A separate license is required. Please contact info@genshin.org .
+
+Open Source Software without emojidex service:
+-------------------------------------------
+When used with features disabled or modified to circumvent emojidex services in any way this software is dual licensed under the GPLv3 and AGPLv3 and as such you software must be licensed under the GPL v3 or your service must be licensed under the AGPL v3. Including images in any format without sources is equivilent to including sources; such that the inclusion of any image assets from emojidex will require you to apply the GPL v3 and AGPL v3 to your software/project.
+
+Licensing of Images:
+--------------------
+All image assets are copyright 2013 Genshin Souzou Kabushiki Kaisha and a copyright notice must be included. Usage of these assets in printed material requires a separate license. Usage of images in software requires compliance to the licensing conditions above. Usage of images in virtual form outside of the context of software projects requires written permission from Genshin Souzou K.K. and may require a separate license.
+
+License fees may be wholly waived for non-religiously affiliated educational institutions and parties who are working for greater social or scientific benefit. Please inquire.
+
+For all license requests please contact info@genshin.org

data/Rakefile

@@ -1,34 +1,8 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+require 'rubygems'
+require 'bundler'
+require 'rake'
+require 'rspec/core/rake_task'
 
-require 'rdoc/task'
+RSpec::Core::RakeTask.new(:spec)
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Emojidex'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task default: :test
+task :default => :spec

data/emoji/categories.json

@@ -0,0 +1,64 @@
+{
+  "categories": [
+    {
+      "code": "faces",
+      "en": "Faces",
+      "ja": "顔"
+    },
+    {
+      "code": "people",
+      "en": "People",
+      "ja": "人"
+    },
+    {
+      "code": "food",
+      "en": "Food",
+      "ja": "食べ物"
+    },
+    {
+      "code": "tools",
+      "en": "Tools",
+      "ja": "道具"
+    },
+    {
+      "code": "objects",
+      "en": "Objects",
+      "ja": "物"
+    },
+    {
+      "code": "gestures",
+      "en": "Gestures",
+      "ja": "ジェスチャー"
+    },
+    {
+      "code": "transportation",
+      "en": "Transportation",
+      "ja": "乗り物"
+    },
+    {
+      "code": "places",
+      "en": "Places",
+      "ja": "場所"
+    },
+    {
+      "code": "nature",
+      "en": "Nature",
+      "ja": "自然"
+    },
+    {
+      "code": "cosmos",
+      "en": "Cosmos",
+      "ja": "宇宙"
+    },
+    {
+      "code": "symbols",
+      "en": "Symbols",
+      "ja": "記号"
+    },
+    {
+      "code": "abstract",
+      "en": "Abstract",
+      "ja": "抽象物"
+    }
+  ]
+}

data/emojidex.gemspec

@@ -1,22 +1,15 @@
-$:.push File.expand_path("../lib", __FILE__)
-
-# Maintain your gem's version:
-require "emojidex/version"
-
-# Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
-  s.name        = "emojidex"
-  s.version     = "0.0.7"
-  s.license     = "GNU GPLv3 and AGPLv3"
-  s.authors     = ['Yukiharu Nakaya', 'Rika Yoshida', 'Rei Kagetsuki']
-  s.email       = ["info@genshin.org"]
-  s.homepage    = "http://genshin.org"
-  s.summary     = "Phantom Open Emoji for Rails"
-  s.description = "Phantom Open Emoji with utilities and resources for Rails."
-
-  s.files = `git ls-files`.split("\n")
-
-  s.add_dependency 'highline'
-  s.add_dependency 'phantom_open_emoji'
-  s.add_dependency 'phantom_open_emoji_static'
+  s.name        = 'emojidex'
+  s.version     = '0.0.9'
+  s.license     = 'GPL-3, AGPL-3'
+  s.summary     = 'emojidex Ruby tools'
+  s.description = 'emojidex emoji handling, search and lookup, listing and caching functionality and user info (favorites/etc).'
+  s.authors     = ['Rei Kagetsuki', 'Jun Tohyama', 'Vassil Kalkov', 'Rika Yoshida']
+  s.email       = 'info@emojidex.com'
+  s.files       = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage    = 'http://dev.emojidex.com'
+
+  s.add_dependency 'faraday',             '0.8.9'
+  s.add_dependency 'faraday_middleware',  '0.9.0'
 end

data/lib/emojidex.rb

@@ -1,4 +1,9 @@
-require "emojidex/engine"
-
-module Emojidex
-end
+require 'json'
+require 'emojidex/emoji'
+require 'emojidex/collection'
+require 'emojidex/utf'
+require 'emojidex/extended'
+require 'emojidex/category'
+require 'emojidex/categories'
+require 'emojidex/client'
+require 'emojidex/error'

data/lib/emojidex/api/categories.rb

@@ -0,0 +1,16 @@
+module Emojidex
+  module API
+    # Get cateegories from API
+    module Categories
+      def categories(*args)
+        response = get('/api/v1/categories.json', args)
+        response[:body]['categories']
+      end
+
+      def category(*args)
+        response = get('/api/v1/categories/category.json', args)
+        response[:body]
+      end
+    end
+  end
+end

data/lib/emojidex/api/emoji.rb

@@ -0,0 +1,26 @@
+module Emojidex
+  module API
+    # Get emoji from API
+    module Emoji
+      def emoji(*args)
+        response = get('/api/v1/emoji.json', args)
+        response[:body]['emoji']
+      end
+
+      def single_emoji(*args)
+        response = get('/api/v1/emoji/emoji.json', args)
+        response[:body]
+      end
+
+      def emoji_detailed(*args)
+        response = get('/api/v1/emoji/detailed.json', args)
+        response[:body]
+      end
+
+      def single_emoji_detailed(*args)
+        response = get('/api/v1/emoji/1/detailed.json', args)
+        response[:body]
+      end
+    end
+  end
+end

data/lib/emojidex/api/search/emoji.rb

@@ -0,0 +1,16 @@
+module Emojidex
+  module API
+    module Search
+      # Search API for emoji
+      module Emoji
+        def emoji_code_cont(term, options = {})
+          response = get(
+                          '/api/v1/search/emoji.json',
+                          options.merge('q[code_cont]' => term)
+                        )
+          response[:body]
+        end
+      end
+    end
+  end
+end

data/lib/emojidex/cache.rb

@@ -0,0 +1,69 @@
+require 'json'
+require_relative 'defaults'
+require 'fileutils'
+
+module Emojidex
+  # local caching functionality for collections
+  module Cache
+    attr_reader :cache_dir
+
+    def setup_cache(path = nil)
+      # check if cache dir is already set
+      return @cache_dir if @cache_dir && path.nil?
+      # setup cache
+      @cache_dir = File.expand_path(path || ENV['EMOJI_CACHE'] || "#{ENV['HOME']}/.emojidex/cache")
+      FileUtils.mkdir_p(@cache_dir)
+      Emojidex::Defaults.sizes.keys.each do |size|
+        FileUtils.mkdir_p(@cache_dir + "/#{size}")
+      end
+      @cache_dir
+    end
+
+    # Caches emoji to local emoji storage cache
+    # Options:
+    #   cache_dir: manually specify cache location
+    #     (default is ENV['EMOJI_CACHE'] or '$HOME/.emoji_cache')
+    #   formats: formats to cache (default is SVG only)
+    #   sizes: sizes to cache (default is px32, but this is irrelivant for SVG)
+    def cache!(options = {})
+      setup_cache options[:cache_dir]
+      formats = options[:formats] || [:svg, :png]
+      sizes = options[:sizes] || [:px32]
+      @emoji.values.each do |moji|
+        _svg_check_copy(moji) if formats.include? :svg
+        _raster_check_copy(moji, :png, sizes) if formats.include? :png
+      end
+      _update_index
+    end
+
+    private
+
+    def _svg_check_copy(moji)
+      src = @source_path + "/#{moji.code}"
+      if File.exist? "#{src}.svg"
+        unless File.exist?("#{@cache_dir}/#{moji.code}.svg") &&
+          FileUtils.compare_file("#{src}.svg", "#{@cache_dir}/#{moji.code}.svg")
+          FileUtils.cp("#{src}.svg", @cache_dir)
+        end
+      end
+      FileUtils.cp_r src, @cache_dir if File.directory? src
+    end
+
+    def _raster_check_copy(moji, format, sizes)
+      sizes.each do |size|
+        src = @source_path + "/#{size}/#{moji.code}"
+        FileUtils.cp "src.#{format}", (@cache_dir + "/#{size}") if FileTest.exist? "src.#{format}"
+        FileUtils.cp_r src, @cache_dir if File.directory? src
+      end
+    end
+
+    def _update_index
+      idx = Emojidex::Collection.new
+      idx.load_local_collection(@cache_dir) if FileTest.exist? "#{@cache_dir}/emoji.json"
+      idx.add_emoji @emoji.values
+      File.open("#{@cache_dir}/emoji.json", 'w') do |f|
+        f.write idx.emoji.values.to_json
+      end
+    end
+  end
+end