haruna 0.0.1.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kakipo
+
+MIT License
+
+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,54 @@
+# Haruna
+
+A Ruby interface to the 艦これ API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'haruna'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install haruna
+
+## Usage
+
+    client = Haruna::Client.new(token)
+
+    # to start a mission
+    client.req_mission_start(deck_id, mission_id)
+
+    # to obtain mission result
+    client.req_mission_result(deck_id)
+
+    # to refill fuel & bullets
+    client.req_hokyu_charge(kind, ship_id_arr)
+
+### Parameter
+
+| 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
+
+This software library ("gem") is provided by kakipo "as is" and "with all faults." kakipo makes no representations or warranties of any kind concerning the safety, suitability, inaccuracies, typographical errors, or other harmful components of this gem. There are inherent dangers in the use of any software, and you are solely responsible for determining whether this gem is compatible with your equipment and other software installed on your equipment. You are also solely responsible for the protection of your equipment and backup of your data, and kakipo will not be liable for any damages you may suffer in connection with using, modifying, or distributing this gem.
+
+Plus, please read and respect [the official terms of use](http://www.dmm.co.jp/rule/=/category=onlinegame_service/).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/haruna.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'haruna/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "haruna"
+  spec.version       = Haruna::VERSION
+  spec.authors       = ["kakipo"]
+  spec.email         = ["kakipo@gmail.com"]
+  spec.description   = %q{Write a gem description}
+  spec.summary       = %q{Write a gem summary}
+  spec.homepage      = "https://github.com/kakipo/haruna"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/lib/haruna/api.rb

@@ -0,0 +1,43 @@
+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)
+      require 'faraday'
+      @token = token
+
+      @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.body = setup_param(param)
+      end
+    end
+
+    def setup_param(param)
+      param.merge(api_verno: API_VER, api_token: @token)
+    end
+
+  end
+end

data/lib/haruna/client.rb

@@ -0,0 +1,55 @@
+module Haruna
+
+  class Client < API
+
+    def initialize(token, proxy=nil)
+      super(token, proxy)
+    end
+
+    def req_mission_start(deck_id, mission_id)
+      validate_deck_id(deck_id)
+      validate_mission_id(mission_id)
+      call("api_req_mission", "start", api_deck_id: deck_id, api_mission_id: mission_id)
+    end
+
+    def req_mission_result(deck_id)
+      validate_deck_id(deck_id)
+      call("api_req_mission", "result", api_deck_id: deck_id)
+    end
+
+    def get_member_deck_port
+      call("api_get_member", "deck_port")
+    end
+
+    # kind
+    #   1: oil?
+    #   2: bullet?
+    #   3: oil + bullet?
+    def req_hokyu_charge(kind, ship_id_arr)
+      validate_supply_kind(kind)
+      validate_ship_ids(ship_id_arr)
+      call("api_req_hokyu", "charge", api_kind: kind, api_id_items: ship_id_arr.join(","))
+    end
+
+    # validators
+    def validate_deck_id(deck_id)
+      raise ArgumentError, "deck id must be between 1~4" unless deck_id.between?(1, 4)
+    end
+
+    def validate_mission_id(mission_id)
+      raise ArgumentError, "mission_id must be positive" unless 0 < mission_id
+    end
+
+    def validate_supply_kind(kind)
+      raise ArgumentError, "kind must be between 1~3" unless kind.between?(1, 3)
+    end
+
+    def validate_ship_ids(ship_id_arr)
+      raise ArgumentError, "at least 1 ship id is required" if ship_id_arr.empty?
+      raise ArgumentError, "at least 1 ship id is required" unless ship_id_arr.select{|id| id <= 0 }.empty?
+    end
+
+
+
+  end
+end

data/lib/haruna/version.rb

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

data/lib/haruna.rb

@@ -0,0 +1,7 @@
+require "haruna/version"
+require "haruna/api"
+require "haruna/client"
+
+module Haruna
+
+end

data/spec/api_spec.rb

@@ -0,0 +1,67 @@
+# -*- encoding: UTF-8 -*-
+require File.expand_path(File.join('./', 'spec_helper'), File.dirname(__FILE__))
+
+describe Haruna::API do
+  describe "#new" do
+
+    context "when token is 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") }
+      it { should be_an_instance_of Haruna::API }
+    end
+  end
+
+  describe "#setup_param" do
+    before do
+      @token = "abcdefg"
+      @api = Haruna::API.new(@token)
+    end
+
+    subject { @api.setup_param(param) }
+
+    context "when passed param has NO elements" do
+      let(:param) { {} }
+      its(:size) { should eq 2 }
+      its([:api_verno]) { should eq 1 }
+      its([:api_token]) { should eq @token }
+    end
+
+    context "when passed param has AN element" do
+      let(:param) { {hoge: :foo} }
+      its(:size) { should eq 3 }
+      its([:hoge]) { should eq :foo }
+      its([:api_verno]) { should eq 1 }
+      its([:api_token]) { should eq @token }
+    end
+  end
+
+  describe "#call" do
+    before do
+      @api = Haruna::API.new("abcdefg")
+      @api.conn = create_stub_connection # overwrite faraday adapter
+    end
+
+    subject { @api.call("get_seafood", target, {}) }
+
+    context "when target is tamago" do
+      let(:target) { "tamago" }
+      its(:body) { should eq 'egg' }
+    end
+
+    context "when target is ebi" do
+      let(:target) { "ebi" }
+      its(:body) { should eq 'shrimp' }
+    end
+
+    context "when target is uni" do
+      let(:target) { "uni" }
+      its(:body) { should eq 'urchin' }
+    end
+  end
+
+end

data/spec/client_spec.rb

@@ -0,0 +1,178 @@
+# coding: utf-8
+require File.expand_path(File.join('./', 'spec_helper'), File.dirname(__FILE__))
+
+describe Haruna::Client do
+
+  describe "#new" do
+    context "when token is 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") }
+      it { should be_an_instance_of Haruna::Client }
+    end
+  end
+
+  describe "client commands" do
+    before do
+      @client = Haruna::Client.new("abcdefg")
+      @client.conn = create_stub_connection # overwrite faraday adapter
+    end
+
+    describe "#req_mission_start" do
+      context "w/o parameters" do
+        it "should raise an error" do
+          expect{ @client.req_mission_start }.to raise_error(ArgumentError)
+        end
+      end
+      context "w/ two parameters" do
+        subject { @client.req_mission_start(1, 1) }
+        its(:body) { should eq "ok" }
+      end
+    end
+
+    describe "#req_mission_result" do
+      context "w/o parameters" do
+        it "should raise an error" do
+          expect{ @client.req_mission_result }.to raise_error(ArgumentError)
+        end
+      end
+      context "w/ two parameters" do
+        subject { @client.req_mission_result(1) }
+        its(:body) { should eq "ok" }
+      end
+    end
+
+    describe "#req_hokyu_charge" do
+      context "w/o parameters" do
+        it "should raise an error" do
+          expect{ @client.req_hokyu_charge }.to raise_error(ArgumentError)
+        end
+      end
+      context "w/ two parameters" do
+        subject { @client.req_hokyu_charge(1, [1,2,3]) }
+        its(:body) { should eq "ok" }
+      end
+    end
+
+    describe "#get_member_deck_port" do
+      context "w/o parameters" do
+        subject { @client.get_member_deck_port }
+        its(:body) { should eq "ok" }
+      end
+      context "w/ a parameter" do
+        it "should raise an error" do
+          expect{ @client.get_member_deck_port(1) }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+  end
+
+  describe "validators" do
+    before do
+      @client = Haruna::Client.new("abcdefg")
+    end
+
+    describe "#validate_deck_id" do
+      subject{ @client.validate_deck_id(deck_id) }
+      context "when deck_id is TOO SMALL" do
+        let(:deck_id) { 0 }
+        it "should raise error" do
+          expect{ subject }.to raise_error(ArgumentError)
+        end
+      end
+      context "when deck_id is MIN" do
+        let(:deck_id) { 1 }
+        it "should not raise error" do
+          expect{ subject }.not_to raise_error
+        end
+      end
+      context "when deck_id is TOO BIG" do
+        let(:deck_id) { 5 }
+        it "should raise error" do
+          expect{ subject }.to raise_error(ArgumentError)
+        end
+      end
+      context "when deck_id is MAX" do
+        let(:deck_id) { 4 }
+        it "should not raise error" do
+          expect{ subject }.not_to raise_error
+        end
+      end
+    end
+
+    describe "#validate_mission_id" do
+      subject{ @client.validate_mission_id(mission_id) }
+      context "when mission_id is TOO SMALL" do
+        let(:mission_id) { 0 }
+        it "should raise error" do
+          expect{ subject }.to raise_error(ArgumentError)
+        end
+      end
+      context "when mission_id is MIN" do
+        let(:mission_id) { 1 }
+        it "should not raise error" do
+          expect{ subject }.not_to raise_error
+        end
+      end
+    end
+
+    describe "#validate_kind" do
+      subject{ @client.validate_supply_kind(kind) }
+      context "when kind is TOO SMALL" do
+        let(:kind) { 0 }
+        it "should raise error" do
+          expect{ subject }.to raise_error(ArgumentError)
+        end
+      end
+      context "when kind is MIN" do
+        let(:kind) { 1 }
+        it "should not raise error" do
+          expect{ subject }.not_to raise_error
+        end
+      end
+      context "when kind is TOO BIG" do
+        let(:kind) { 4 }
+        it "should raise error" do
+          expect{ subject }.to raise_error(ArgumentError)
+        end
+      end
+      context "when kind is MAX" do
+        let(:kind) { 3 }
+        it "should not raise error" do
+          expect{ subject }.not_to raise_error
+        end
+      end
+    end
+
+    describe "#validate_ship_ids" do
+      subject{ @client.validate_ship_ids(id_arr) }
+      context "when id_arr is empty" do
+        let(:id_arr) { [] }
+        it "should raise error" do
+          expect{ subject }.to raise_error(ArgumentError)
+        end
+      end
+      context "when id_arr is VALID" do
+        let(:id_arr) { [1, 2, 3] }
+        it "should not raise error" do
+          expect{ subject }.not_to raise_error
+        end
+      end
+      context "when id_arr contains INVALID id" do
+        let(:id_arr) { [1, 2, 0, 3] }
+        it "should raise error" do
+          expect{ subject }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'rubygems'
+require 'haruna'
+
+def create_stub_connection
+  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' ]}
+
+  end
+
+  Faraday.new do |builder|
+    builder.adapter :test, stubs
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: haruna
+version: !ruby/object:Gem::Version
+  version: 0.0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- kakipo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- haruna.gemspec
+- lib/haruna.rb
+- lib/haruna/api.rb
+- lib/haruna/client.rb
+- lib/haruna/version.rb
+- spec/api_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kakipo/haruna
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Write a gem summary
+test_files:
+- spec/api_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb