qingting_api 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0396665a3c1cb2bc62540f39831cb8641c6b041
+  data.tar.gz: 84ab29eb16ecbe768f8addca9dd2e53282880576
+SHA512:
+  metadata.gz: 035fc2aab053561edb8e5c8486f0e86c536473a2634fb1fc0a6cd8d45c8de1830df5a2646b4ba7ad81bbbb0fd3d0a91d065ee8c5f5c9a4dbcc439b5cf3f8cf49
+  data.tar.gz: d1b5e7aeead920ca4d4702970a1cd9f490dae2a6e847dcc544f539a59382e8ce18be403d3a33729ba29b1badb80a3f45dbf67ce8d0dcb4b958c1ff73f69e2b2d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Cheenwe
+
+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,101 @@
+# QingtingApi
+
+蜻蜓FM,接口
+http://open.qingting.fm/documents/API%20%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3/
+
+## 安装  
+
+在您的 `Gemfile` 里面添加:
+
+```
+gem 'qingting_api'
+```
+
+然后, 在 console 中执行下面的代码:
+
+``` 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                   = 20   # 获取信息时, 一页包含信息数量
+    # config.company                     = 'Cheenwe'    # 申请api公司名称
+    # config.expires_in                  = 7200.second    # 过期时间。当access_token过期时，API会返回token_expired错误。这时需要重新申请access token
+end
+```
+
+## 接口方法
+
+#### 音频数据中心
+> |方法|API|说明
+|:-----  |:-------|-----                               |
+|QingtingApi.mediacenterlist  |
+ /v6/media/mediacenterlist  | 获取域名中心
+
+#### 分类(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)    |
+ /v6/media/categories/#{category_id}/channels/order/0/curpage/#{curpage}/pagesize/30 |获取分类下的所有电台或直播电台
+ 
+#### 点播(OnDemand)
+
+> |方法|API|说明
+|:-----  |:-------|-----                               |
+|QingtingApi.get("channelondemands/35242") / QingtingApi.get_id("channelondemands",35242) |
+ /v6/media/channelondemands/#{channel_id}  |  获取点播电台
+|QingtingApi.ondemand_channel(35242,1)  |
+ /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.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.search("上海") /QingtingApi.search("上海","channel_ondemand") |  /search/#{keyword}/type/#{type}| 搜索 
+ 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cheenwe/qingting_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/lib/generators/qingting_api/config_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module QingtingApi
+  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.
+DESC
+
+      def copy_config_file
+        template 'qingting_api_config.rb', 'config/initializers/qingting_api_config.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+QingtingApi.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                   = 20   # 获取信息时, 一页包含信息数量
+    # config.company                     = 'Cheenwe'    # 申请api公司名称
+    # config.expires_in                  = 7200.second    # 过期时间。当access_token过期时，API会返回token_expired错误。这时需要重新申请access token
+end

data/lib/qingting_api/account.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'net/http'
+require 'active_support/json'
+
+module QingtingApi
+  # Module that handle user information
+  #
+  module Account
+    module_function
+
+    # 获取账户 token
+    #
+    def access_token
+      post 'access', grant_type: "client_credentials", client_id: QingtingApi.config.client_id, client_secret:QingtingApi.config.client_secret
+    end
+
+
+    def post(api, options = {})
+      uri = URI.join(QingtingApi.config.base_url, api)
+      res = Net::HTTP.post_form(uri, options)
+      result res.body
+    end
+
+
+    def result(body)
+      begin
+       resule =  ActiveSupport::JSON.decode body
+       resule['access_token']
+      rescue => e
+        {
+          code: 502,
+          msg: '内容解析错误',
+          detail: e.to_s
+        }
+      end
+    end
+  end
+end

data/lib/qingting_api/config.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'active_support/configurable'
+require 'active_support/core_ext'
+
+module QingtingApi
+
+  # curl  -X POST "http://api.open.qingting.fm/access?&grant_type=client_credentials" -d "client_id=ZTk4MzAwMzAtYWFiOC0xMWU0LTkyM2YtMDAxNjNlMDAyMGFk&client_secret=OTdiNmI0MWEtYzhiZC0zYWE1LWExZmEtMDU0OWZhNTljZmRk"
+
+  # client_id和client_secret，用以后续获取access_token
+  def self.configure(&block)
+    yield @config ||= QingtingApi::Configuration.new
+  end
+
+  # Global settings for QingtingApi
+  def self.config
+    @config
+  end
+
+  # Configuration class
+  #
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    # client_id和client_secret，用以后续获取access_token
+    config_accessor :base_url                     # api url
+    config_accessor :client_id                     # 授权 API client_id
+    config_accessor :client_secret                     # 授权 API client_secret
+    config_accessor :api_version                 # API 的版本,目前有v6
+    config_accessor :page_num                    # 获取信息时, 指定默认的页数
+    config_accessor :page_size                   # 获取信息时, 一页包含信息数量
+    config_accessor :company                     # 默认公司名称
+    config_accessor :expires_in                  # 过期时间。当access_token过期时，API会返回token_expired错误。这时需要重新申请access token
+  end
+
+  configure do |config|
+    config.base_url                     = "http://api.open.qingting.fm"
+    config.client_id                     = "ZTk4MzAwMzAtYWFiOC0xMWU0LTkyM2YtMDAxNjNlMDAyMGFk"
+    config.client_secret                     = "OTdiNmI0MWEtYzhiZC0zYWE1LWExZmEtMDU0OWZhNTljZmRk"
+    config.api_version                 = :v6
+    config.page_num                    = 1
+    config.page_size                   = 20
+    config.company                     = 'Cheenwe'
+    config.expires_in                  = 7200.second
+  end
+end

data/lib/qingting_api/qing_ting.rb

@@ -0,0 +1,62 @@
+module QingtingApi
+	# Message service: methods that are used to manage messages
+	module QingTing
+
+		def self.included(base)
+			base.send :extend, ClassMethods
+		end
+
+		# Class methods
+		module ClassMethods
+
+			def find_by_cid(cmode, cid)
+				Request.get "#{cmode}", cid: cid
+			end
+
+			def method_missing(name, *args)
+				if name != /^get_(.*)/
+					Request.get  "/#{QingtingApi.config.api_version}/media/#{name}?access_token=#{token}"
+				else
+					{
+						code: 404,
+						msg: 'NOT FIND'
+					}
+				end
+			end
+
+			def get(name)
+				Request.get  "/#{QingtingApi.config.api_version}/media/#{name}?access_token=#{token}"
+			end
+
+			def get_id(name, id)
+				Request.get  "/#{QingtingApi.config.api_version}/media/#{name}/#{id}?access_token=#{token}"
+			end
+
+			def catrgory_channel(category_id, curpage)
+				Request.get  "/#{QingtingApi.config.api_version}/media/categories/#{category_id}/channels/order/0/curpage/#{curpage}/pagesize/30?access_token=#{token}"
+			end
+
+			def ondemand_channel(category_id, curpage)
+				Request.get  "/#{QingtingApi.config.api_version}/media/channelondemands/#{category_id}/programs/curpage/#{curpage}/pagesize/30?access_token=#{token}"
+			end
+
+			def live_channel(channel_id, day)
+				Request.get  "/#{QingtingApi.config.api_version}/media/channellives/#{channel_id}/programs/day/#{day}?access_token=#{token}"
+			end
+
+			def search(keyword, type={})
+				if type.present?
+					Request.get  "/search/#{CGI.escape(keyword)}/type/#{type}?access_token=#{token}"
+				else
+					Request.get  "/search/#{CGI.escape(keyword)}/type/all?access_token=#{token}"
+				end
+			end
+
+			def token
+				QingtingApi::Account.access_token
+			end
+
+		end
+
+	end
+end

data/lib/qingting_api/request.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require 'net/http'
+require 'active_support/json'
+
+module QingtingApi
+  # Module that manage requests
+  module Request
+    # Method that use `Net::HTTP.post_form` to perform `POST` action
+    #
+    def post(api, options = {})
+      uri = URI.join(base_url, api)
+      res = Net::HTTP.post_form(uri, options)
+      result res.body
+    end
+
+    # Method that use `Net::HTTP.get` to perform `GET` action
+    #
+    def get(api, options = {})
+      url = URI.join(base_url, api)
+      result Net::HTTP.get(url)
+
+      # uri = URI('http://example.com/index.html')
+      # params = { :limit => 10, :page => 3 }
+      # uri.query = URI.encode_www_form(params)
+
+      # res = Net::HTTP.get_response(uri)
+    end
+
+    private
+
+    # Method that parse JSON to Hash
+    #
+    def result(body)
+      begin
+        ActiveSupport::JSON.decode body
+      rescue => e
+        {
+          code: 502,
+          msg: '内容解析错误',
+          detail: e.to_s
+        }
+      end
+    end
+
+    # Base uri for Qingting API
+    def base_url
+      "#{QingtingApi.config.base_url}"
+    end
+
+    module_function :post, :get, :result, :base_url
+  end
+end

data/lib/qingting_api/version.rb

@@ -0,0 +1,3 @@
+module QingtingApi
+  VERSION = "0.1.3"
+end

data/lib/qingting_api.rb

@@ -0,0 +1,17 @@
+require "qingting_api/version"
+require 'qingting_api/config'
+require 'qingting_api/request'
+require 'qingting_api/qing_ting'
+
+require 'qingting_api/account'
+
+unless defined? ActiveRecord
+  begin
+    require 'active_record'
+  rescue LoadError; end
+end
+
+module QingtingApi
+  include QingTing
+
+end

data/qingting_api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qingting_api/version'
+
+Gem::Specification.new do |s|
+  s.name          = "qingting_api"
+  s.version       = QingtingApi::VERSION
+  s.authors       = ["cheenwe"]
+  s.email         = ["cheenwe@gmail.com"]
+
+  s.summary       = "Qingting Fm ruby api"
+  s.description   = "Qingting Fm ruby api"
+  s.homepage      = "https://github.com/cheenwe/qingting_api"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+
+  s.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
+  s.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency 'rails', ['>= 3.1.0']
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: qingting_api
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- cheenwe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Qingting Fm ruby api
+email:
+- cheenwe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/qingting_api/config_generator.rb
+- lib/generators/qingting_api/templates/qingting_api_config.rb
+- lib/qingting_api.rb
+- lib/qingting_api/account.rb
+- lib/qingting_api/config.rb
+- lib/qingting_api/qing_ting.rb
+- lib/qingting_api/request.rb
+- lib/qingting_api/version.rb
+- qingting_api.gemspec
+homepage: https://github.com/cheenwe/qingting_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.5.0
+signing_key: 
+specification_version: 4
+summary: Qingting Fm ruby api
+test_files: []
+has_rdoc: