shangrila 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eaf046b26dbd7a367d160809630ace16af53591
-  data.tar.gz: 6f42595566d7bc8065f3a9178953903e0bbc5f29
+  metadata.gz: adf42aac72a8f696b10fb52670c4bf93652eaf44
+  data.tar.gz: b8e000edfd449ae32f01c0d9126feaa53d47427b
 SHA512:
-  metadata.gz: 90c839727d35ac3b51f9add376b995e0bfe24b6759bb98f7d02775466582735bbf38eeb05181ab67b62061c956932bfefe8c0d850ad13fec46a131916cc4933e
-  data.tar.gz: 6faeba4f1a964e183a87064ecbda3803ea74eb4ee599143bd77446e62a629431202ffeb3f5d4eed0995e07d1fb30e5ec222f56f72fa842aecd78138754e7c539
+  metadata.gz: 34d00970cea3314a447bf1f5fe14e109dcfc71b1220d512a744d5eff2f90eb0375b8529d5c1d967b898587c24936cc9b026e88ad29be26d50b501203f39cebbd
+  data.tar.gz: ff934ee7916d79b0c1020f956a3b56250bf80b8d77d91ccc163a4af2049d8dcaeca73017f8fbb0c7465340feaea8ae7f231e0ce40e3e84a076a5f3e9a9e22ff8

data/README.md

@@ -1,10 +1,35 @@
 #ShangriLa SDK for Ruby
 
-
 ##Install
 
 ``gem install shangrila``
 
 or Gemfile
 
-``gem 'shangrila'``
+``gem 'shangrila'``
+
+##Usage
+
+### Get master record
+
+```Shangrila::Sora.new().get_master_data(year, cours)```
+
+```Shangrila::Sora.new().get_master_data(2014, 1)```
+
+### Get anime title list
+
+```Shangrila::Sora.new().get_title_list(year, cours)```
+
+```Shangrila::Sora.new().get_title_list(2015, 1)```
+
+### Get anime title map
+
+```Shangrila::Sora.new().get_map_with_key_title(year, cours, property)```
+
+```Shangrila::Sora.new().get_map_with_key_title(2015, 2, 'twitter_account')```
+
+### Get flat data
+
+```Shangrila::Sora.new().get_flat_data(year, cours, property_list)```
+
+```Shangrila::Sora.new().get_flat_data(2014, 2, ['title', 'twitter_hash_tag'])```

data/lib/shangrila/sora.rb

@@ -13,17 +13,26 @@ module Shangrila
     def initialize
     end
 
-    #Shangrila::Sora.new().get_title_list(year, cours)
+    # @param [Int] year データ取得対象のアニメの年
+    # @param [Int] cours データ取得対象のアニメの年のクール番号 1-4
+    # @return [JSON] アニメのマスターデータすべて
     def get_master_data(year, cours)
       response = HTTPClient.get(sprintf("%s/%s/%s", URL, year, cours))
       JSON.load(response.body)
     end
 
+    # @param [Int] year データ取得対象のアニメの年
+    # @param [Int] cours データ取得対象のアニメの年のクール番号 1-4
+    # @return [JSON] アニメのマスターデータのタイトルリスト
     def get_title_list(year, cours)
       master_list = get_master_data(year, cours)
       master_list.map{|master| master['title']}
     end
 
+    # @param [Int] year データ取得対象のアニメの年
+    # @param [Int] cours データ取得対象のアニメの年のクール番号 1-4
+    # @param [property] データ取得対象のプロパティ
+    # @return [HASH] タイトルをkey、propertyに対応する値をValueとしたハッシュ
     def get_map_with_key_title(year, cours, property)
       master_list = get_master_data(year, cours)
 
@@ -34,7 +43,10 @@ module Shangrila
       master_map
     end
 
-    ## Shangrila::Sora.new().get_flat_data(year, cours, ['title', 'twitter_hash_tag'])
+    # @param [Int] year データ取得対象のアニメの年
+    # @param [Int] cours データ取得対象のアニメの年のクール番号 1-4
+    # @param [property] データ取得対象のプロパティリスト
+    # @return [Array] 1タイトル1配列としたフラット配列
     def get_flat_data(year, cours, property_list)
       master_list = get_master_data(year, cours)
       records = master_list.map{|master| property_list.map{|p|master[p]} }

data/lib/shangrila/version.rb

@@ -1,3 +1,3 @@
 module Shangrila
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shangrila
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - AKB428