foursquare2, foursquare v2 api的ruby 包装器

分享于 

6分钟阅读

GitHub

  繁體 雙語
Ruby wrapper for the foursquare v2 api
  • 源代码名称:foursquare2
  • 源代码网址:http://www.github.com/mattmueller/foursquare2
  • foursquare2源代码文档
  • foursquare2源代码下载
  • Git URL:
    git://www.github.com/mattmueller/foursquare2.git
    Git Clone代码到本地:
    git clone http://www.github.com/mattmueller/foursquare2
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/mattmueller/foursquare2
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    foursquare2

    foursquare的ruby 包装器。

    安装

    
    sudo gem install foursquare2
    
    
    
    

    用法

    关于身份验证的注释

    目前这个 gem 不处理oauth2认证流程,使用 oauth2 gem 插件来检索和存储用户的oauth令牌。 获取userless的客户密钥/秘密,在 foursquare开发者站点上访问。

    实例化客户端( Userless访问)

    
    client = Foursquare2::Client.new(:client_id => 'your_client_id', :client_secret => 'your_secret')
    
    
    
    

    实例化客户端( 验证用户访问权限)

    
    client = Foursquare2::Client.new(:oauth_token => 'user_oauth_token')
    
    
    
    

    实例化客户机( 带版本控制)

    
    client = Foursquare2::Client.new(:api_version => '20120505')
    
    
    
    

    示例

    有关所有支持方法和可用选项的列表,请参见文档

    获取有关已经验证用户的用户( 用户'自身的信息
    
    client.user(108914)
    
    
    
    
    获得有关地点的信息
    
    client.venue(5104)
    
    
    
    
    搜索场地
    
    client.search_venues(:ll => '36.142064,-86.816086', :query => 'Starbucks')
    
    
    
    
    以验证用户身份登录到场所
    
    client.add_checkin(:venueId =>"4b2afcaaf964a5205bb324e3", :broadcast => 'public', :ll => '36.142064,-86.816086', :shout => 'zomg coffee!1!')
    
    
    
    
    按提示搜索用户的搜索
    
     client.search_users_by_tip(:ll => '36.142064,-86.816086', :name => 'Marco')
    
    
    
    
    从用户的搜索提示( 根据某个术语过滤用户提示)
    
     client.user_tips("123456", :query => 'coffee')
    
    
    
    
    按提示搜索
    
     client.search_venues_by_tip(:ll => '36.142064,-86.816086', :query => 'coffee')
    
    
    
    
    ( 根据某项条件,在某一地点) 搜索提示( 根据某项术语过滤
    
     client.venue_tips("4b2afcaaf964a5205bb324e3", :query => 'coffee')
    
    
    
    

    方法的完整列表

    参见列表的文档或者端点for参数。

    
    client.checkin
    
    
    client.recent_checkins
    
    
    client.add_checkin
    
    
    client.add_checkin_comment
    
    
    client.add_checkin_post
    
    
    client.add_checkin_reply
    
    
    client.delete_checkin_comment
    
    
    client.photo
    
    
    client.add_photo
    
    
    client.settings
    
    
    client.setting
    
    
    client.update_setting
    
    
    client.special
    
    
    client.search_specials
    
    
    client.tip
    
    
    client.search_tips
    
    
    client.add_tip
    
    
    client.mark_tip_todo
    
    
    client.mark_tip_done
    
    
    client.unmark_tip
    
    
    client.user
    
    
    client.search_users
    
    
    client.user_requests
    
    
    client.user_badges
    
    
    client.user_checkins
    
    
    client.user_friends
    
    
    client.user_photos
    
    
    client.user_tips
    
    
    client.user_mayorships
    
    
    client.user_todos
    
    
    client.user_venue_history
    
    
    client.user_friend_request
    
    
    client.user_unfriend
    
    
    client.user_approve_friend
    
    
    client.user_deny_friend
    
    
    client.user_set_friend_pings
    
    
    client.venue
    
    
    client.venue_tips
    
    
    client.venue_links
    
    
    client.venue_photos
    
    
    client.page
    
    
    client.search_pages
    
    
    client.herenow
    
    
    client.page_venues
    
    
    client.managed_pages
    
    
    client.search_venues
    
    
    client.search_venues_by_tip
    
    
    client.venue_categories
    
    
    client.trending_venues
    
    
    client.add_venue
    
    
    client.mark_venue_todo
    
    
    client.flag_venue
    
    
    client.propose_venue_edit
    
    
    client.edit_venue
    
    
    client.managed_venues
    
    
    client.managed_venue_stats
    
    
    client.venues_timeseries
    
    
    client.add_special
    
    
    client.add_campaign
    
    
    
    

    待办事项

    • 更多测试覆盖
    • 集成oauth2身份验证流程

    提供 foursquare2

    • 检查最新的主机,确保功能没有实现,或者 Bug 尚未被修复。
    • 查看问题跟踪程序以确保某人已经没有请求它并/或者贡献它
    • fork 项目
    • 启动特征/修正分支
    • 提交并推送直到你对自己的贡献满意
    • 一定要为它添加测试。 这很重要,所以我不会在以后的版本中无意中。
    • 请不要与 Rakefile,版本或者历史混淆。 如果你想有自己的版本或者是必要的,那么很好,但是请隔离它自己的提交。

    版权

    版权所有( c ) 2011 Matt Mueller。 有关详细信息,请参阅 LICENSE.txt。


    API  WRAP  换行  Foursquare