haruna 0.0.1.2 → 0.0.2

data/README.md

@@ -18,25 +18,53 @@ Or install it yourself as:
 
 ## Usage
 
-    client = Haruna::Client.new(token)
+```ruby
+client = Haruna::Client.new(token, end_point)
 
-    # to start a mission
-    client.req_mission_start(deck_id, mission_id)
+# start a mission
+client.req_mission_start(deck_id, mission_id)
 
-    # to obtain mission result
-    client.req_mission_result(deck_id)
+# obtain mission result
+client.req_mission_result(deck_id)
 
-    # to refill fuel & bullets
-    client.req_hokyu_charge(kind, ship_id_arr)
+# refill fuel & bullets
+client.req_hokyu_charge(kind, ship_id_arr)
+```
 
-### Parameter
+### Parameters
+
+| Param         | Description    | Sample                                     | Constraint |
+| ------------- | -------------- | ------------------------------------------ | ---------- |
+| token         | Your API token | "835d2a8f2ca5fea2463248cc6910af96880fc29e" |            |
+| end_point     | API endpoint   | "http://125.6.189.215"                     |            |
+| ship_id       | Ship's id      | 35                                         | 1          |
+| deck_id       | Deck's id      | 3                                          | 1 ~ 4      |
+| kind          | Refill mode - 1: fuel, 2: bullets, 3: fuel + bullets  | 3   | 1 ~ 3      |
+
+### Configuration
+
+You can configure a `Haruna::Client` by passing it options when it's initialized.
+
+```ruby
+# specify proxy server
+proxy_client = Haruna::Client.new(token, end_point, proxy: "http://127.0.0.1:8888")
+
+# you can modify HTTP request header
+client = Haruna::Client.new(token, end_point, user_agent: "My User Agent", accept_enc: "gzip")
+# or you can rewrite the settings after initialization
+client.user_agent = "Foo Bar"
+```
+
+| Option         | Description       | Default                              | 
+| -------------- | ----------------- | ------------------------------------ | 
+| :proxy         | Proxy server URL  | nil                                  | 
+| :api_ver       | API version       | 1                                    | 
+| :user_agent    | User Agent        |  "Mozilla/5.0 (M..."                 | 
+| :referer       | Referer           |  "/kcs/port.swf?version=1.5.5"       | 
+| :accept_enc    | Accept-Encoding   |  "gzip,deflate,sdch"                 | 
+| :accept_lang   | Accept-Encoding   |  "ja,en-US;q=0.8,en;q=0.6"           | 
+| :content_type  | Content-Type      |  "application/x-www-form-urlencoded" | 
 
-| Param         | Description    | Constraint |
-| ------------- | -------------- | ---------- |
-| token         | Your API token |            |
-| ship_id       | Ship's id      | 1 ~        |
-| deck_id       | Deck's id      | 1 ~ 4      |
-| kind          | Refill mode - 1: oil, 2: bullets, 3: oil + bullets      | 1 ~ 3 |
 
 
 ## Disclaimer

data/haruna.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
 end

data/lib/haruna/api.rb

@@ -1,42 +1,52 @@
 module Haruna
 
   class API
-    # config req header
-    API_VER         = 1
-    END_POINT       = 'http://125.6.189.215'
-    USER_AGENT      = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.63 Safari/537.36'
-    REFERER = 'http://125.6.189.215/kcs/port.swf?version=1.5.5'
-    ACCEPT_ENCODING = 'gzip,deflate,sdch'
-    ACCEPT_LANGUAGE = 'ja,en-US;q=0.8,en;q=0.6'
-    CONTENT_TYPE    = 'application/x-www-form-urlencoded'
-
-    def initialize(token, proxy=nil)
+    attr_writer :conn # for testing, not really need to rewrite this
+    attr_accessor :proxy, :api_ver, :user_agent, :referer, :accept_enc, :accept_lang, :content_type
+
+    DEFAULT_OPTS = {
+      proxy:          nil,
+      api_ver:        1,
+      user_agent:     'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.63 Safari/537.36',
+      referer:        '/kcs/port.swf?version=1.5.5', # 'http://125.6.189.215/kcs/port.swf?version=1.5.5'
+      accept_enc:     'gzip,deflate,sdch',
+      accept_lang:    'ja,en-US;q=0.8,en;q=0.6',
+      content_type:   'application/x-www-form-urlencoded'
+    }
+
+    def initialize(token, end_point, opts={})
       require 'faraday'
       @token = token
+      @end_point = end_point
+
+      self.setup(opts || {})
 
-      @conn = Faraday.new(:url => END_POINT, :proxy => proxy) do |faraday|
+      @conn = Faraday.new(:url => @end_point, :proxy => @proxy) do |faraday|
         faraday.request  :url_encoded
         # faraday.response :logger
         faraday.adapter  Faraday.default_adapter
       end
     end
 
-    attr_writer :conn # for testing, not really need to rewrite
-
     def call(action, target, param={})
       @conn.post do |req|
         req.url "/kcsapi/#{action}/#{target}"
-        req.headers['User-Agent']       = USER_AGENT
-        req.headers['Referer']          = REFERER
-        req.headers['Accept-Encoding']  = ACCEPT_ENCODING
-        req.headers['Accept-Language']  = ACCEPT_LANGUAGE
-        req.headers['Content-Type']     = CONTENT_TYPE
+        req.headers['User-Agent']       = @user_agent
+        req.headers['Referer']          = "#{@end_point}#{@referer}"
+        req.headers['Accept-Encoding']  = @accept_enc
+        req.headers['Accept-Language']  = @accept_lang
+        req.headers['Content-Type']     = @content_type
         req.body = setup_param(param)
       end
     end
 
     def setup_param(param)
-      param.merge(api_verno: API_VER, api_token: @token)
+      param.merge(api_verno: @api_ver, api_token: @token)
+    end
+
+    def setup(opts)
+      DEFAULT_OPTS.merge(opts).each { |key, value| instance_variable_set("@#{key}", value) }
+      self
     end
 
   end

data/lib/haruna/client.rb

@@ -2,8 +2,8 @@ module Haruna
 
   class Client < API
 
-    def initialize(token, proxy=nil)
-      super(token, proxy)
+    def initialize(token, end_point, opts={})
+      super(token, end_point, opts)
     end
 
     def req_mission_start(deck_id, mission_id)
@@ -22,9 +22,9 @@ module Haruna
     end
 
     # kind
-    #   1: oil?
-    #   2: bullet?
-    #   3: oil + bullet?
+    #   1: fuel
+    #   2: bullet
+    #   3: fuel + bullet
     def req_hokyu_charge(kind, ship_id_arr)
       validate_supply_kind(kind)
       validate_ship_ids(ship_id_arr)

data/lib/haruna/version.rb

@@ -1,3 +1,3 @@
 module Haruna
-  VERSION = "0.0.1.2"
+  VERSION = "0.0.2"
 end

data/spec/api_spec.rb

@@ -2,24 +2,44 @@
 require File.expand_path(File.join('./', 'spec_helper'), File.dirname(__FILE__))
 
 describe Haruna::API do
-  describe "#new" do
+  before do
+    @token = "abcdefg"
+    @end_point = "http://125.6.189.215"
+  end
 
-    context "when token is empty" do
+  describe "#new" do
+    context "when token & end_point are empty" do
       it "should raise error" do
         expect{ Haruna::API.new }.to raise_error(ArgumentError)
       end
     end
 
-    context "when token is NOT empty" do
-      subject { Haruna::API.new("abcdefg") }
+    context "when token & end_point are specified" do
+      subject { Haruna::API.new(@token, @end_point) }
       it { should be_an_instance_of Haruna::API }
     end
   end
 
+  describe "#setup_param" do
+    subject { Haruna::API.new(@token, @end_point, opts) }
+    context "when opt is empty" do
+      let(:opts) { nil }
+      describe "return value" do
+        it { should be_an_instance_of Haruna::API }
+      end
+      describe "default setting" do
+        its(:api_ver) { should eq 1 }
+        its(:accept_enc) { should eq "gzip,deflate,sdch" }
+        its(:accept_lang) { should eq "ja,en-US;q=0.8,en;q=0.6" }
+        its(:content_type) { should eq "application/x-www-form-urlencoded" }
+      end
+    end
+  end
+
   describe "#setup_param" do
     before do
-      @token = "abcdefg"
-      @api = Haruna::API.new(@token)
+      @token = @token
+      @api = Haruna::API.new(@token, @end_point)
     end
 
     subject { @api.setup_param(param) }
@@ -42,7 +62,7 @@ describe Haruna::API do
 
   describe "#call" do
     before do
-      @api = Haruna::API.new("abcdefg")
+      @api = Haruna::API.new(@token, @end_point)
       @api.conn = create_stub_connection # overwrite faraday adapter
     end
 

data/spec/client_spec.rb

@@ -3,22 +3,27 @@ require File.expand_path(File.join('./', 'spec_helper'), File.dirname(__FILE__))
 
 describe Haruna::Client do
 
+  before do
+    @token = "abcdefg"
+    @end_point = "http://125.6.189.215"
+  end
+
   describe "#new" do
-    context "when token is empty" do
+    context "when token & end_point are empty" do
       it "should raise error" do
         expect{ Haruna::Client.new }.to raise_error(ArgumentError)
       end
     end
 
-    context "when token is NOT empty" do
-      subject { Haruna::Client.new("abcdefg") }
+    context "when token & end_point are NOT empty" do
+      subject { Haruna::Client.new(@token, @end_point) }
       it { should be_an_instance_of Haruna::Client }
     end
   end
 
   describe "client commands" do
     before do
-      @client = Haruna::Client.new("abcdefg")
+      @client = Haruna::Client.new(@token, @end_point)
       @client.conn = create_stub_connection # overwrite faraday adapter
     end
 
@@ -30,7 +35,7 @@ describe Haruna::Client do
       end
       context "w/ two parameters" do
         subject { @client.req_mission_start(1, 1) }
-        its(:body) { should eq "ok" }
+        its(:body) { should start_with "svdata" }
       end
     end
 
@@ -42,7 +47,7 @@ describe Haruna::Client do
       end
       context "w/ two parameters" do
         subject { @client.req_mission_result(1) }
-        its(:body) { should eq "ok" }
+        its(:body) { should start_with "svdata" }
       end
     end
 
@@ -54,14 +59,14 @@ describe Haruna::Client do
       end
       context "w/ two parameters" do
         subject { @client.req_hokyu_charge(1, [1,2,3]) }
-        its(:body) { should eq "ok" }
+        its(:body) { should start_with "svdata" }
       end
     end
 
     describe "#get_member_deck_port" do
       context "w/o parameters" do
         subject { @client.get_member_deck_port }
-        its(:body) { should eq "ok" }
+        its(:body) { should start_with "svdata" }
       end
       context "w/ a parameter" do
         it "should raise an error" do
@@ -74,7 +79,7 @@ describe Haruna::Client do
 
   describe "validators" do
     before do
-      @client = Haruna::Client.new("abcdefg")
+      @client = Haruna::Client.new(@token, @end_point)
     end
 
     describe "#validate_deck_id" do

data/spec/spec_helper.rb

@@ -1,18 +1,30 @@
 # encoding: utf-8
 require 'rubygems'
 require 'haruna'
+require 'pry'
 
 def create_stub_connection
+
+  resp_headers = {"date"=>"Sat, 21 Dec 2013 04:11:07 GMT", "server"=>"Apache", "x-powered-by"=>"PHP/5.3.3", "content-length"=>"149", "content-type"=>"text/plain", "proxy-connection"=>"Close"}
+
   stubs = Faraday::Adapter::Test::Stubs.new do |stub|
     # stub.post(url) { [status_code, response_header, response_body] }
     stub.post('/kcsapi/get_seafood/tamago') {[ 200, {}, 'egg' ]}
     stub.post('/kcsapi/get_seafood/ebi') {[ 200, {}, 'shrimp' ]}
     stub.post('/kcsapi/get_seafood/uni') {[ 200, {}, 'urchin' ]}
 
-    stub.post('/kcsapi/api_req_mission/start') {[ 200, {}, 'ok' ]}
-    stub.post('/kcsapi/api_req_mission/result') {[ 200, {}, 'ok' ]}
-    stub.post('/kcsapi/api_req_hokyu/charge') {[ 200, {}, 'ok' ]}
-    stub.post('/kcsapi/api_get_member/deck_port') {[ 200, {}, 'ok' ]}
+    # stub.post(url) { [status_code, response_header, response_body] }
+    stub.post('/kcsapi/api_req_mission/start') {[ 200, resp_headers,
+      "svdata={\"api_result\":1,\"api_result_msg\":\"\\u6210\\u529f\",\"api_data\":{\"api_complatetime\":1387604467275,\"api_complatetime_str\":\"2013-12-21 14:41:07\"}}" ]} # BOM: \xEF\xBB\xBF
+
+    stub.post('/kcsapi/api_req_mission/result') {[ 200, resp_headers,
+      "svdata={\"api_result\":1,\"api_result_msg\":\"\\u6210\\u529f\",\"api_data\":{\"api_ship_id\":[-1,54,78,71,50],\"api_clear_result\":1,\"api_get_exp\":20,\"api_member_lv\":28,\"api_member_exp\":40216,\"api_get_ship_exp\":[22,15,15,15],\"api_get_exp_lvup\":[[2157,2800],[1730,2100],[2230,2800],[1555,2100]],\"api_maparea_name\":\"\\u93ae\\u5b88\\u5e9c\\u6d77\\u57df\",\"api_detail\":\"\\u5916\\u6d77\\u307e\\u3067\\u8db3\\u3092\\u5ef6\\u3070\\u3057\\u3001\\u8266\\u968a\\u306e\\u7df4\\u5ea6\\u3092\\u9ad8\\u3081\\u3088\\u3046\\uff01\",\"api_quest_name\":\"\\u9577\\u8ddd\\u96e2\\u7df4\\u7fd2\\u822a\\u6d77\",\"api_quest_level\":1,\"api_get_material\":[0,100,30,0],\"api_useitem_flag\":[1,0],\"api_get_item1\":{\"api_useitem_id\":-1,\"api_useitem_name\":null,\"api_useitem_count\":1}}}" ]}
+
+    stub.post('/kcsapi/api_req_hokyu/charge') {[ 200, resp_headers,
+      "svdata={\"api_result\":1,\"api_result_msg\":\"\\u6210\\u529f\",\"api_data\":{\"api_ship\":[{\"api_id\":54,\"api_fuel\":15,\"api_bull\":15,\"api_onslot\":[0,0,0,0,0]},{\"api_id\":78,\"api_fuel\":15,\"api_bull\":15,\"api_onslot\":[0,0,0,0,0]},{\"api_id\":71,\"api_fuel\":15,\"api_bull\":15,\"api_onslot\":[0,0,0,0,0]},{\"api_id\":50,\"api_fuel\":15,\"api_bull\":15,\"api_onslot\":[0,0,0,0,0]}],\"api_material\":[2938,5864,4151,3933],\"api_use_bou\":0}}" ]}
+
+    stub.post('/kcsapi/api_get_member/deck_port') {[ 200, resp_headers,
+      "svdata={\"api_result\":1,\"api_result_msg\":\"\\u6210\\u529f\",\"api_data\":[{\"api_member_id\":15010331,\"api_id\":1,\"api_name\":\"First\",\"api_name_id\":\"\",\"api_mission\":[0,0,0,0],\"api_flagship\":\"0\",\"api_ship\":[109,156,177,31,194,30]},{\"api_member_id\":15010331,\"api_id\":2,\"api_name\":\"Second\",\"api_name_id\":\"\",\"api_mission\":[1,5,1387598754473,0],\"api_flagship\":\"0\",\"api_ship\":[15,66,57,83,-1,-1]},{\"api_member_id\":15010331,\"api_id\":3,\"api_name\":\"Third\",\"api_name_id\":\"\",\"api_mission\":[1,2,1387595310643,0],\"api_flagship\":\"0\",\"api_ship\":[54,78,71,50,-1,-1]}]}" ]}
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haruna
 version: !ruby/object:Gem::Version
-  version: 0.0.1.2
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Write a gem description
 email:
 - kakipo@gmail.com