qingting_api 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6656001c6cf4598d4edf825161f4435c67ecaa0
-  data.tar.gz: c5d96d5f08dde055b5709afb12463330d2c1f5c0
+  metadata.gz: 863714ea2312c498b85964d27d465ebf5407de99
+  data.tar.gz: 3b2f9e14f206bda8c335028d086d83254a82fd93
 SHA512:
-  metadata.gz: d1c72d1cb5fbdecd9d7a37b36549629ac4532eb947a3f023d863336793ecc14eef07e52fcf6c31ef84f80741a78c54115514cccb05ff95ebedbb6610c6b9a28c
-  data.tar.gz: 431c91bf58881e9545dad59c6a77c9f6281a50fec00acfe1a5dd34e8b7a0d1b6f629e54c34606aea3523249209cafb9f3830cf35247bcd694b7ec02b9ae1bd52
+  metadata.gz: 527912eaf379bf186af62eaac834a3111d80e40685172c23b8ae362ed0331acfe9a6af35ae9df00d88cd7bc654904c7ecf0effd2ae4e988391f1f53ea5d8f441
+  data.tar.gz: 3f79c238895307d94c68098d01c7bf9064c30ba86b6ecf0e0814b550793ab43e0052c9077eb3ae4c7cbbed49f6f4555167cfe2dcbb75c728c75b2dcc25855074

data/README.md

@@ -1,9 +1,10 @@
-# QingtingApi
+# Qingting
 
-蜻蜓FM,接口
-http://open.qingting.fm/documents/API%20%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3/
+蜻蜓FM  Ruby API
 
-## 安装  
+[API 开发文档](http://open.qingting.fm/documents/API%20%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3/)
+
+## 安装
 
 在您的 `Gemfile` 里面添加:
 
@@ -16,75 +17,160 @@ gem 'qingting_api'
 ``` bash
 # 安装gem
 bundle
- 
+
 rails g qingting_api:config  # 将会拷贝配置文件至 `config/initializers/qingting_api.rb`
 ```
 
 ## 配置
 
 ``` ruby
-SmartSMS.configure do |config|
-
-    # config.base_url                     = "http://api.open.qingting.fm"    # api url
-    # config.client_id                     = "ZTk4MzAwMzAtYWFiOC0xMWU0LTkyM2YtMDAxNjNlMDAyMGFk"     # 授权 API client_id
-    # config.client_secret                     = "OTdiNmI0MWEtYzhiZC0zYWE1LWExZmEtMDU0OWZhNTljZmRk"          # 授权 API client_secret
-    # config.api_version                 = :v6    # API 的版本,目前有v6
-    # config.page_num                    = 1  # 获取信息时, 指定默认的页数
-    # config.page_size                   = 30   # 获取信息时, 一页包含信息数量
-    # config.company                     = 'Cheenwe'    # 申请api公司名称
-    # config.expires_in                  = 7200.second    # 过期时间。当access_token过期时，API会返回token_expired错误。这时需要重新申请access token
+Qingting.configure do |config|
+  # config.base_url                    = "http://api.open.qingting.fm"    # api url
+  # config.client_id                   = "ZTk4MzAwMzAtYWFiOC0xMWU0LTkyM2YtMDAxNjNlMDAyMGFk"     # 授权 API client_id
+  # config.client_secret               = "OTdiNmI0MWEtYzhiZC0zYWE1LWExZmEtMDU0OWZhNTljZmRk"          # 授权 API client_secret
+  # config.api_version                 = :v6    # API 的版本,目前有v6
+  # config.page_num                    = 1  # 获取信息时, 指定默认的页数
+  # config.page_size                   = 30   # 获取信息时, 一页包含信息数量
 end
 ```
 
 ## 接口方法
 
-#### 音频数据中心
-> |方法|API|说明
-|:-----  |:-------|-----                               |
-|QingtingApi.mediacenterlist  | /v6/media/mediacenterlist  | 获取域名中心
+Autho2.0授权
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi::Account.access_token | /access  | [Autho2.0授权](http://open.qingting.fm/documents/documents/Autho2.0授权/) | |
+
+音频数据中心
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.mediacenterlist | /v6/media/mediacenterlist  | <a href="http://open.qingting.fm/documents/documents/获取音频流拼取规则/">获取域名中心</a> | |
+
+
+分类(Category)
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.categories | /v6/media/categories | <a href="http://open.qingting.fm/documents/documents/获取点播所有分类/">获取点播所有分类</a> | |
+| QingtingApi.category(id) | /v6/media/categories/5 | <a href="http://open.qingting.fm/documents/documents/直播分类及获取直播属性/">直播分类及获取直播属性</a> | |
+| QingtingApi.category(id) | /v6/media/categories/#{category_id} | <a href="http://open.qingting.fm/documents/documents/获取某个分类下的属性/">获取分类属性</a> | |
+| QingtingApi.channels(category_id, current_page, page_size) | /v6/media/categories/#{category_id}/channels/order/0/curpage/#{curpage}/pagesize/30 | <a href="http://open.qingting.fm/documents/documents/获取分类下的所有电台或直播电台/">获取分类下的所有电台或直播电台</a> | |
+| QingtingApi.channels_attr(category_id, attrs, current_page, page_size)  | /v6/media/categories/#{category_id}/channels/order/0/attr/#{attr_id_1}/#{attr_id_2}/.../curpage/#{curpage}/pagesize/30 | <a href="http://open.qingting.fm/documents/documents/获取分类下的所有电台或直播电台，并按属性筛选/">通过属性筛选分类的点播电台或直播电台</a> | |
+| QingtingApi.recommend_guides | /v6/media/recommends/guides/section/#{section_id} | <a href="http://open.qingting.fm/documents/documents/获取点播分类推荐/">点播分类推荐</a> | |
+| QingtingApi.live_banner | /v6/media/recommend/live/banner | <a href="http://open.qingting.fm/documents/documents/获取直播banner内容/">直播banner内容</a> | |
+
+
+
+点播(OnDemand)
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.channelondemand(channel_id) | /v6/media/channelondemands/#{channel_id} | <a href="http://open.qingting.fm/documents/documents/获取点播电台/">获取点播电台</a> | |
+| QingtingApi.channel(id)| /wapi/channels/#{channel_id} | <a href="http://open.qingting.fm/documents/documents/(新)获取点播电台/">(新)获取点播电台</a> | |
+| QingtingApi.wapi_programs(channel_id, curpage, page_size) | /wapi/channelondemands/#{channel_id}/programs/curpage/#{curpage}/pagesize/#{pagesize} | <a href="http://open.qingting.fm/documents/documents/(新)获取点播电台节目单/">(新)获取点播电台节目单</a> | |
+| QingtingApi.programs(channel_id, curpage, page_size) | /v6/media/channelondemands/#{channel_id}/programs/curpage/#{curpage}/pagesize/30 | <a href="http://open.qingting.fm/documents/documents/获取点播电台下的点播节目/">获取点播电台下的点播节目</a> | |
+
+| QingtingApi.program(id) | /v6/media/programs/#{programid} | <a href="http://open.qingting.fm/documents/documents/获取点播节目/">获取点播节目</a> | |
+| QingtingApi.recommends(channel_id, curpage, page_size) | /v6/media/channelondemands/#{channel_id}/recommends/curpage/#{curpage}/pagesize/#{pagesize} | <a href="http://open.qingting.fm/documents/documents/获取电台推荐列表/">获取电台推荐列表</a> | |
+
+
+直播(Live)
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.channellive(id) | /v6/media/channellives/#{channel_id} | <a href="http://open.qingting.fm/documents/documents/获取直播电台/">获取直播电台</a> | |
+| QingtingApi.live_channel(id) | /wapi/channels/#{channel_id} | <a href="http://open.qingting.fm/documents/documents/(新)获取直播电台/">(新)获取直播电台</a> | |
+| QingtingApi.channellives(channel_id, days)  | /v6/media/channellives/#{channel_id}/programs/day/#{day_1}/#{day_2}/.../ | <a href="http://open.qingting.fm/documents/documents/获取直播电台节目单/">获取直播电台节目单</a> | days: day1,day2,day3,... |
+| QingtingApi.nowplaying(day_of_week) | /v6/media/recommends/nowplaying/day/＃{day_of_week} | <a href="http://open.qingting.fm/documents/documents/获取正在直播电台列表/">获取正在直播电台列表</a> | |
+
+
+临时直播节目(Live)
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.program(id) | /v6/media/programs/#{programid} | <a href="http://open.qingting.fm/documents/documents/获取临时直播信息/">获取临时直播信息</a> | |
+
+排行榜
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.recommends_billboards_channellives | /v6/media/recommends/billboards/channellives | <a href="http://open.qingting.fm/documents/documents/电台排行榜/">电台排行榜</a> | |
+| QingtingApi.recommends_billboards_programondemands | /v6/media/recommends/billboards/programondemands | <a href="http://open.qingting.fm/documents/documents/点播节目排行榜/">点播节目排行榜</a> | |
+| QingtingApi.categories_billboard(category_id) | /wapi/categories/#{category_id}/channels/billboard | <a href="http://open.qingting.fm/documents/documents/分类排行榜/">分类排行榜</a> | |
+| QingtingApi.type_billboard(category_id,type) | /v6/media/categories/#{category_id}/channels/billboard/#{type} | <a href="http://open.qingting.fm/documents/documents/获取不同类型的分类排行榜/">获取不同类型的分类排行榜</a> | |
+
+搜索
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.newsearch(keyword, type) | /newsearch/#{keyword}/type/#{type} | <a href="http://open.qingting.fm/documents/documents/新搜索/">新搜索</a> | |
+| QingtingApi.search_hotkeywords | /search/hotkeywords | <a href="http://open.qingting.fm/documents/documents/搜索热词/">搜索热词</a> | |
+| QingtingApi.suggest(keyword) | /newsearch/suggest?k=#{keyword} | <a href="http://open.qingting.fm/documents/documents/获取搜索提示/">获取搜索提示</a> | |
+
+获取内容更新状态
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.categories_recent(start_time, end_time) | /v6/media/categories/recent/starttime/#{starttime}/endtime/#{endtime} | <a href="http://open.qingting.fm/documents/documents/获取点播分类的更新状态/">获取点播分类的更新状态</a> | |
+| QingtingApi.channels_recent(category_id, start_time, end_time, current_page=1, page_size=30) | /v6/media/categories/#{category_id}/recent/channels/starttime/#{starttime}/endtime/#{endtime}/curpage/#{curpage}/pagesize/#{pagesize} | <a href="http://open.qingting.fm/documents/documents/查询某个点播分类在指定时间段内所有点播分类的更新状态/">查询某个点播分类在指定时间段内所有点播分类的更新状态</a> | |
+| QingtingApi.channelondemands_recent(channelondemand_id, start_time, end_time, current_page=1, page_size=30) | /v6/media/channelondemands/#{channelondemand_id}/recent/starttime/#{starttime}/endtime/#{endtime}/curpage/#{curpage}/pagesize/#{pagesize} | <a href="http://open.qingting.fm/documents/documents/查询某个点播专辑在指定时间段内节目的更新状态/">查询某个点播专辑在指定时间段内节目的更新状态</a> | |
+| QingtingApi.live_recent(start_time, end_time, current_page=1, page_size=30) | /v6/media/categories/live/recent/channels/starttime/#{starttime}/endtime/#{endtime}/curpage/#{curpage}/pagesize/#{pagesize} | <a href="http://open.qingting.fm/documents/documents/查询直播电台在指定时间段内的更新状态/">查询直播电台在指定时间段内的更新状态</a> | |
+
+主播
+----
+
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.podcaster_guides | /v6/media/podcasters/guides | <a href="http://open.qingting.fm/documents/documents/获取主播推荐页面信息/">获取主播推荐页面信息</a> | |
+| QingtingApi.podcasters_attributes | /v6/media/podcasters/attributes | <a href="http://open.qingting.fm/documents/documents/获取主播分类属性/">获取主播分类属性</a> | |
+| QingtingApi.podcasters_type(type, page) | /v6/media/podcasters/type/#{type}/page/#{page} | <a href="http://open.qingting.fm/documents/documents/获取主播排行榜或新增主播/">获取主播排行榜或新增主播</a> | |
+| QingtingApi.podcasters_recommends | /v6/media/podcasters/attr/#{attrIds}/page/#{page} | <a href="http://open.qingting.fm/documents/documents/获取属性的所有主播/">获取属性的所有主播</a> | |
+| QingtingApi.podcasters_attr(attr_ids, page) |  /v6/media/podcasters/recommends | <a href="http://open.qingting.fm/documents/documents/获取推荐的主播/">获取推荐的主播</a> | |
+| QingtingApi.podcaster(id) | /v6/media/podcasters/#{qingting_id} | <a href="http://open.qingting.fm/documents/documents/获取主播信息/">获取主播信息</a> | |
+| QingtingApi.podcasters_channelondemands(qingting_id) | /v6/media/podcasters/#{qingting_id}/channelondemands | <a href="http://open.qingting.fm/documents/documents/获取主播专辑列表/">获取主播专辑列表</a> | |
+| QingtingApi.podcasters_recent(qingting_id) | /v6/media/podcasters/#{qingting_id}/recent | <a href="http://open.qingting.fm/documents/documents/获取主播最近更新节目/">获取主播最近更新节目</a> | |
 
-#### 分类(Category)
+此刻
+----
 
-> |方法|API|说明
-|:-----  |:-------|-----                               |
-|QingtingApi.categories  | /v6/media/categories  |  获取点播所有分类
-|QingtingApi.get("categories/5") /QingtingApi.get_id("categories",5)  | /v6/media/categories/5  |直播分类及获取直播属性
-|QingtingApi.get("categories/5") /QingtingApi.get_id("categories",5)   | /v6/media/categories/#{category_id} |获取分类属性
-|QingtingApi.catrgory_channel(category_id, curpage, page_size)    | /v6/media/categories/#{category_id}/channels/order/0/curpage/#{curpage}/pagesize/30 |获取分类下的所有电台或直播电台
- 
-#### 点播(OnDemand)
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.now| /v6/media/now | <a href="http://open.qingting.fm/documents/documents/获取此时此刻节目列表/">获取此时此刻节目列表</a> | |
 
-> |方法|API|说明
-|:-----  |:-------|-----                               |
-|QingtingApi.get("channelondemands/35242") / QingtingApi.get_id("channelondemands",35242) | /v6/media/channelondemands/#{channel_id}  |  获取点播电台
-|QingtingApi.ondemand_channel(35242,1,30)  | /v6/media/channelondemands/#{channel_id}/programs/curpage/#{curpage}/pagesize/30  |  获取点播电台下的点播节目
-|QingtingApi.get("programs/3568700") / QingtingApi.get_id("programs",3568700)   | /v6/media/programs/#{programid}| 获取点播节目
+专题
+----
 
-#### 直播(Live)
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.topic(topic_id) | /v6/media/topics/#{topic_id} | <a href="http://open.qingting.fm/documents/documents/获取专题的专辑列表/">获取专题的专辑列表</a> | |
 
-> |方法|API|说明
-|:-----  |:-------|-----                               |
-|QingtingApi.get("channellives/266") / QingtingApi.get_id("channellives",266) | /v6/media/channellives/#{channel_id} |   获取直播电台
-|QingtingApi.live_channel(266,4)  | /v6/media/channellives/#{channel_id}/programs/day/#{day_1}/#{day_2}/.../ |   获取直播电台节目单
-#### 排行榜
+活动
+----
 
-> |方法|API|说明
-|:-----  |:-------|-----                               |
-|QingtingApi.get("recommends/billboards/channellives") | /v6/media/recommends/billboards/channellives   | 电台排行榜
-|QingtingApi.get("recommends/billboards/programondemands")  | /v6/media/recommends/billboards/programondemands |   点播节目排行榜
+| 方法 | API | 接口文档 | 说明 |
+| --- | --- | --- | --- |
+| QingtingApi.activity(activity_id) | v6/media/activities/#{activity_id} | <a href="http://open.qingting.fm/documents/documents/获取活动信息/">获取活动信息</a> | |
 
-#### 搜索
-> |方法|API|说明
-|:-----  |:-------|-----                               |
-|QingtingApi.search("上海") /QingtingApi.search("上海","channel_ondemand") |  /search/#{keyword}/type/#{type}| 搜索 
- 
 
 
 ## Change log
 
-> |时间|版本|说明|
-|:-----  |:-------|-----                               |
-|2015.12.08  | 0.1.5 |添加自定义分页参数                       |
+| 时间 | 版本 | 接口文档 |
+| --- | ---- | ----  |
+|2015.12.08  | 0.1.5 | 添加自定义分页参数 |
+|2016.12.31  | 0.2.0 | API 接口更新  |
+|2017.01.03~01.08 | 0.3.0 | 重构全部接口  |
 
 ## Contributing
 

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qingting_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/lib/generators/qingting_api/config_generator.rb

@@ -1,14 +1,14 @@
 require 'rails/generators'
 require 'rails/generators/active_record'
 
-module QingtingApi
+module Qingting
   module Generators
     class ConfigGenerator < Rails::Generators::Base
       source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
 
       desc <<-DESC
 Description:
-    Copies QingtingApi configuration file to your application's initializer directory.
+    Copies Qingting configuration file to your application's initializer directory.
 DESC
 
       def copy_config_file

data/lib/generators/qingting_api/templates/qingting_api_config.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-QingtingApi.configure do |config|
+Qingting.configure do |config|
 
     # config.base_url                     = "http://api.open.qingting.fm"    # api url
     # config.client_id                     = "ZTk4MzAwMzAtYWFiOC0xMWU0LTkyM2YtMDAxNjNlMDAyMGFk"     # 授权 API client_id

data/lib/qingting/api/account.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module Qingting
+  module Api
+    module Account
+      extend self
+
+      # 获取账户 token
+      #
+      def access_token
+        token_hash['access_token']
+      end
+
+      def token_hash
+        validate_token_hash
+        @token_hash ||=
+          begin
+            @token_request_at = Time.now
+            params = {
+              grant_type: Base.get_grant_type,
+              client_id: Base.get_client_id,
+              client_secret: Base.get_client_secret
+            }
+            url = Base.access_url
+            result = Utils::Request.post(url, params: params)
+            result
+          end
+      end
+
+      # Check token expired or not
+      def validate_token_hash
+        if @token_request_at and
+            @token_hash and @token_hash['expires_in'] and
+            (Time.now - @token_request_at) > @token_hash['expires_in'].to_i
+          @token_hash = nil
+        elsif @token_request_at and
+            @token_hash and @token_hash['expires_in']
+          @token_hash['access_token']
+        else
+          puts "start get token ..."
+        end
+      end
+    end
+  end
+end

data/lib/qingting/api/base.rb

@@ -0,0 +1,62 @@
+module Qingting
+	module Api
+		module Base
+			extend self
+
+			def base_url
+				Config::get('base_url')
+			end
+
+			def media_url
+				base_url + '/v6/media/'
+			end
+
+			def wapi_url
+				base_url + '/wapi/'
+			end
+
+			def access_url
+				base_url + '/access'
+			end
+
+			def params
+				{
+					access_token: token
+				}
+			end
+
+
+			# 1. Base.v6_categories
+			# 2. Base.wapi_categories
+			# 3. Base.get_client_id
+			def method_missing(name, *args)
+				if name =~ /^v6_[\w]+/
+					name = name.to_s.gsub("v6_", "")
+					# puts name
+					media_url + name.to_s.gsub('_',"/")
+
+					# puts base_url + '/v6/media/' + name.to_s.gsub('_',"/")
+
+				elsif  name =~ /^wapi_[\w]+/
+					name = name.to_s.gsub("wapi_", "")
+					base_url + '/wapi/' + name.to_s.gsub('_',"/")
+
+				elsif  name =~ /^get_[\w]+/
+					name = name.to_s.gsub("get_", "")
+					Config::get(name)
+				end
+			end
+
+			def token
+				Account.access_token
+			end
+
+
+			def request(url)
+				Utils::Request.get(url, params: params)
+			end
+
+		end
+	end
+end
+

data/lib/qingting/api/billboard.rb

@@ -0,0 +1,40 @@
+require 'qingting/api/base'
+
+module Qingting
+  module Api
+    module Billboard
+      # extend self
+
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+
+      # Class methods
+      module ClassMethods
+
+        def recommends_billboards_channellives
+          url = eval("Base.v6_recommends_billboards_channellives")
+          Base.request(url)
+        end
+
+        def recommends_billboards_programondemands
+          url = eval("Base.v6_recommends_billboards_programondemands")
+          Base.request(url)
+        end
+
+        def categories_billboard(category_id)
+          url = eval("Base.v6_categories_#{category_id}_channels_billboard")
+          Base.request(url)
+        end
+
+        def type_billboard(category_id,type)
+          url = eval("Base.v6_categories_#{category_id}_channels_billboard_#{type}")
+          Base.request(url)
+        end
+
+      end
+    end
+  end
+end
+
+

data/lib/qingting/api/category.rb

@@ -0,0 +1,51 @@
+require 'qingting/api/base'
+
+module Qingting
+  module Api
+    module Category
+      # extend self
+
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+
+      # Class methods
+      module ClassMethods
+        def mediacenterlist
+          Base.request(Base.v6_mediacenterlist)
+        end
+
+        def categories
+          Base.request(Base.v6_categories)
+        end
+
+        def category(id)
+          url = eval("Base.v6_categories_#{id}")
+          Base.request(url)
+        end
+
+        def channels(category_id, current_page = Base.get_current_page, page_size = Base.get_page_size)
+          url = Base.media_url + "categories/#{category_id}/channels/order/0/curpage/#{current_page}/pagesize/#{page_size}"
+          Base.request(url)
+        end
+
+        def channels_attr(category_id, attrs, current_page = Base.get_current_page, page_size = Base.get_page_size)
+          attrs = attrs.gsub(".","/")
+          url = Base.media_url + "categories/#{category_id}/channels/order/0/attr/#{attrs}/curpage/#{current_page}/pagesize/#{page_size}"
+          Base.request(url)
+        end
+
+        def recommend_guides
+          url = Base.media_url + "recommend/guides"
+          Base.request(url)
+        end
+
+        def live_banner
+          url = Base.media_url + "recommend/live/banner"
+          Base.request(url)
+        end
+
+      end
+    end
+  end
+end