fanyi_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ff7d13c1eecc30e7b8079ad40b1d8746ab89514
+  data.tar.gz: 6a8123cc48afd24a16a952cb2046adeacd371389
+SHA512:
+  metadata.gz: b6a44dfadfb3e5bbfd0ce2d4674d8a64c047af50e680525cafe1e734426d8851824356a86d2b80dc31b4ce4d50086f67666c2bdc35566096228cbf3fad793415
+  data.tar.gz: e2440d50b2214944710b99838048476b8ea0ccd5ed71694f07b05bc715192ed2ddd67a2b0cbe87a50967066366420474275035d7424ec9aac0299bb3e8884bfd

data/lib/fanyi_api/api.rb

@@ -0,0 +1,27 @@
+module FanyiAPI
+  module API
+
+    StrategyNotRegistered = Class.new StandardError
+
+    extend self
+
+    # register a strategy
+    def register(strategy, options={})
+      stra_sym = :"@#{strategy}"
+      stra = instance_variable_get stra_sym
+      if stra.nil?
+        strategy_class = eval("FanyiAPI::Strategies::#{strategy.camel_case}")
+        instance_variable_set stra_sym, strategy_class.new(options).extend(FanyiAPI::Requester)
+        define_method(strategy) { instance_variable_get stra_sym }
+      end
+    end
+
+    # call strategy with action and arguments
+    def call(strategy="youdao", query)
+      stra = instance_variable_get :"@#{strategy}"
+      raise StrategyNotRegistered if stra.nil?
+      stra.(query)
+    end
+
+  end
+end

data/lib/fanyi_api/requester.rb

@@ -0,0 +1,32 @@
+module FanyiAPI
+  module Requester
+
+    InvalidQuery   = Class.new ArgumentError
+
+    def conn
+      @conn ||= Faraday.new
+    end
+
+    def call(query)
+      raise InvalidQuery, "Invalid query" if query.blank?
+      url  = URI.encode(request_url)
+      resp = conn.get request_url, q: query
+      parse resp
+    end
+
+    private
+
+    # get response body, if the body is nil or we fail
+    # to parse the body, return nil
+    def parse(resp)
+      resp = resp[0] if resp.is_a?(Array)
+      resp = resp.body
+      begin
+        JSON.parse resp
+      rescue JSON::ParserError, TypeError
+        nil
+      end
+    end
+
+  end
+end

data/lib/fanyi_api/strategies/default.rb

@@ -0,0 +1,15 @@
+module FanyiAPI
+  module Strategies
+
+    InvalidStrategy = Class.new ArgumentError
+
+    class Default
+
+      def request_url
+        raise InvalidStrategy, "Strategy is not provided"
+      end
+
+    end
+  end
+
+end

data/lib/fanyi_api/strategies/youdao.rb

@@ -0,0 +1,31 @@
+module FanyiAPI
+  module Strategies
+
+    InvalidKey   = Class.new ArgumentError
+
+    class Youdao < Default
+
+      def initialize(params={})
+        @options = {
+          host:       "http://fanyi.youdao.com/openapi.do",
+          version:    "1.1",
+          doctype:    "json",
+          type:       "data"
+        }.merge(params)
+      end
+
+      def api_url
+        @api_url ||= "#{@options[:host]}?type=#{@options[:type]}&doctype=#{@options[:doctype]}&version=#{@options[:version]}"
+      end
+
+      def request_url
+        raise InvalidKey, "Key is not provided!" \
+          if @options[:keyfrom].nil? || @options[:key].nil?
+
+        @request_url ||= api_url + "&keyfrom=" + @options[:keyfrom] + "&key=" + @options[:key]
+      end
+
+    end
+  end
+
+end

data/lib/fanyi_api/version.rb

@@ -0,0 +1,5 @@
+module FanyiAPI
+
+  VERSION = '0.0.1'
+
+end

data/lib/fanyi_api.rb

@@ -0,0 +1,13 @@
+module FanyiAPI
+  require 'faraday'
+  require 'extlib'
+  require 'ostruct'
+  require 'json'
+
+  require_relative 'fanyi_api/strategies/default'
+  require_relative 'fanyi_api/strategies/youdao'
+
+  require_relative 'fanyi_api/api'
+  require_relative 'fanyi_api/requester'
+
+end

data/spec/fanyi_api/api_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe FanyiAPI::API do
+
+  describe "#call" do
+
+    it "raise strategy not registered error" do
+      expect { FanyiAPI::API.("ciba", "hello") }.to \
+        raise_error(FanyiAPI::API::StrategyNotRegistered)
+    end
+
+    describe "#registed strategy" do
+
+      before do
+        FanyiAPI::API.register "youdao", key: "key", keyfrom: "keyfrom"
+        stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get("/url") { [200, {}, 'foo'] }
+        end
+        allow(Faraday).to receive(:new).and_return(stubs)
+      end
+
+      it "calls youdao" do
+        expect(FanyiAPI::API.youdao).to \
+          receive(:call).with("hello").and_return("/url")
+
+        FanyiAPI::API.("youdao", "hello")
+      end
+
+    end
+
+
+  end
+
+end

data/spec/fanyi_api/requester_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe FanyiAPI::Requester do
+
+  let(:request_url)     { "http://fanyi.youdao.com/openapi.do?type=data&doctype=json&version=1.1&keyfrom=keyfrom&key=key" }
+  let(:youdao)          { FanyiAPI::Strategies::Youdao.new key: "key", keyfrom: "keyfrom"  }
+  let(:requester)       { youdao.extend(FanyiAPI::Requester) }
+  let(:conn)            { requester.conn }
+  let(:file)            { File.read File.join(File.expand_path(File.dirname(__FILE__)), "../fixtures/youdao.json") }
+  let(:response)        { OpenStruct.new body: file }
+
+  describe "#fanyi" do
+
+    it "calls only when find is present" do
+      expect(conn).to receive(:get).with(request_url, {:q=>"hello"}).and_return(response)
+      requester.("hello")
+    end
+
+    it 'returns error if strategy do not respond to the action' do
+      expect{ requester.find_unkown }.to raise_error
+    end
+
+  end
+
+end

data/spec/fanyi_api/strategies/default_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe FanyiAPI::Strategies::Default do
+
+  describe "#raise_error" do
+
+    it "raise key not found if type is not provided" do
+      expect { FanyiAPI::Strategies::Default.new.request_url }.to \
+        raise_error(FanyiAPI::Strategies::InvalidStrategy)
+    end
+
+  end
+
+end

data/spec/fanyi_api/strategies/youdao_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe FanyiAPI::Strategies::Youdao do
+
+  let(:strategy) { FanyiAPI::Strategies::Youdao.new(key: "key", keyfrom: "keyfrom") }
+
+  it "returns api url" do
+    expect(strategy.api_url).to eq \
+      "http://fanyi.youdao.com/openapi.do?type=data&doctype=json&version=1.1"
+  end
+
+  it "returns request url" do
+    expect(strategy.request_url).to eq \
+      "http://fanyi.youdao.com/openapi.do?type=data&doctype=json&version=1.1&keyfrom=keyfrom&key=key"
+  end
+
+  describe "#raise_error" do
+
+    it "raise key not found if type is not provided" do
+      expect { FanyiAPI::Strategies::Youdao.new.request_url }.to \
+        raise_error(FanyiAPI::Strategies::InvalidKey)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require "fanyi_api"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: fanyi_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Qi He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: extlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+description: |2
+      An English to Chinese translation tool using open APIs, such as Youdao, iCiba, etc.
+email: qhe@heyook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fanyi_api/api.rb
+- lib/fanyi_api/requester.rb
+- lib/fanyi_api/strategies/default.rb
+- lib/fanyi_api/strategies/youdao.rb
+- lib/fanyi_api/version.rb
+- lib/fanyi_api.rb
+- spec/fanyi_api/api_spec.rb
+- spec/fanyi_api/requester_spec.rb
+- spec/fanyi_api/strategies/default_spec.rb
+- spec/fanyi_api/strategies/youdao_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/he9qi/fanyi_api
+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.0.14
+signing_key: 
+specification_version: 4
+summary: English to Chinese Translation APIs Wrapper in Ruby.
+test_files:
+- spec/fanyi_api/api_spec.rb
+- spec/fanyi_api/requester_spec.rb
+- spec/fanyi_api/strategies/default_spec.rb
+- spec/fanyi_api/strategies/youdao_spec.rb
+- spec/spec_helper.rb