bleacher_api 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72fac7fe1fa85dd960436f1fa3962c138f71915e
+  data.tar.gz: 5b26b5e8d88427b8c4702795fabc0e988ef65612
+SHA512:
+  metadata.gz: 0aa91a68dc269e6f5d460ad8d72971a3adb1760039eaee8b327562d83ad26f8ffdb686ad6ba7afdb2908e3861008272a8e23b9c7e8cd79c6223fbd1dc3705252
+  data.tar.gz: 31df598505f70ff2299187b1da9d0f634b863f0c31aef187d1f4f93139621f3505bd36bddba17a99145d450d0682e1c4f948f115b2d44f80f24516bcf49f1190

data/README.md

@@ -18,7 +18,9 @@ Table of Contents
 * [POST /api/authenticate/login.json](#authenticate_login_post)
 * [GET /api/authenticate/logout.json](#authenticate_logout)
 * [GET /api/authenticate/signup](#authenticate_signup)
+* [POST /api/authenticate/forgot_password](#authenticate_forgot_password)
 * [GET /api/front/lead_articles.json](#front_lead_articles)
+* [GET /api/front/v2/lead_articles.json](#front_lead_articles_v2)
 * [GET /api/geolocation/teams.json](#geolocation_teams)
 * [GET /api/related/channel.json](#related_channel)
 * [GET /api/related/channel_next.json](#related_channel_next)
@@ -37,6 +39,7 @@ GET /api/article/article.json
 * article[entry_id] - Changes article body to a quick hit or live blog entry
 * article[only] - When given comma-separated parameters, returns only values for the parameters in JSON output
 * comments[page] - When given a page number, action includes comments in JSON output
+* comments[order] = When given an order (in sql syntax), action includes comments in JSON output sorted by order
 * related_content - When given any value, action includes related content in JSON output
 
 ### Returns
@@ -161,6 +164,36 @@ http://bleacherreport.com/api/authenticate/signup?redirect_url=http://bleacherre
 A `redirect_url` parameter is mandatory. B/R will redirect the request back to that URL, passing basic information
 from the <a href="#user_user">User API</a> as GET parameters.
 
+<a name="authenticate_forgot_password"></a>
+
+POST /api/authenticate/forgot_password
+----------------------------
+
+### Parameters
+
+* email
+* redirect_url (optional)
+* format (optional) - json or not
+
+### Returns
+
+Either json of success/error, html status of 200 or 404 (for ajax), or redirect.
+
+### HTTP Example
+
+<pre>
+http://bleacherreport.com/api/authenticate/forgot_password.json?email=bherman@bleacherreport.com
+</pre>
+
+### Paramter Info
+
+Email parameter is mandatory.
+
+If requesting json, redirect_url will be ignored.  If non-json and redirect_url, the request will be treated as html and redirect to the specified url.
+If no params, it will be treated as an html request, but only return a status code of 200 for success or 404 for error (which could be an inability to find the email or any other error).
+
+On success, a forgot password email will be triggered.
+
 <a name="front_lead_articles"></a>
 
 GET /api/front/lead_articles.json
@@ -168,14 +201,24 @@ GET /api/front/lead_articles.json
 
 ### Parameters
 
-* limit - Optional
+* tags - Optional; comma separated list of team permalinks
+* devicetype - Optional; currently supports 'ipad'
+* appversion - Optional; 
+* page - Optional
+* perpage - Optional
+* limit - Optional; deprecated - use perpage
 
 ### Returns
 
-An array of article objects with the following keys: permalink, primary\_image\_650x440, and title.
+An array of article objects with the following keys: permalink, primary\_image\_650x440, 
+primary\_image\_311x210, title and tag (the tag of the teamstream from which the article came).
 
 The array of articles represents the articles currently on the lead module of the front page.
 
+For appversion >= '1.4' and devicetype = 'ipad', specifying one or more tags will
+return an array of articles, with the articles currently on the lead module of the front
+page merged with articles from the team streams of the specified teams.
+
 ### Ruby Example
 
 <pre>
@@ -186,10 +229,78 @@ BleacherApi::Front.lead_articles(:limit => 2)
 
 <pre>
 http://bleacherreport.com/api/front/lead_articles.json?limit=2
+http://bleacherreport.com/api/front/lead_articles.json?tags=san-francisco-49ers,oakland-raiders&devicetype=ipad&appversion=1.4&page=1&perpage=10
 </pre>
 
 <a name="geolocation_teams"></a>
 
+<a name="front_lead_articles_v2"></a>
+GET /api/front/v2/lead_articles.json
+------------------------------------
+
+### Parameters
+* tags - Optional; comma separated list of team permalinks
+* devicetype - Optional; currently supports 'ipad'
+* appversion - Optional
+* page - Optional
+* perpage - Optional; default 5
+
+### Returns
+
+An object containing: 1) a variable with the maximun number of articles available for the query, disregarding
+the perpage parameter, and 2) an array of article objects with the following keys: permalink, primary\_image\_650x440, 
+primary\_image\_311x210, title and tag (the tag of the teamstream from which the article came).
+
+The array of articles represents the articles currently on the lead module of the front page.
+
+For devicetype = 'ipad', specifying one or more tags will
+return an array of articles, with the articles currently on the lead module of the front
+page merged with articles from the team streams of the specified teams.
+
+<pre>
+{
+  all_articles: 53,
+  articles: 
+    [
+      {
+        permalink: "979252-nba-rumors-roundup-chris-paul-to-clippers-latest-on-dwight-howard-and-more",
+        primary_image_311x210: "http://img.bleacherreport.net/img/images/photos/001/484/347/326afbbaae76d91b000f6a706700345b_0_original_crop_exact.jpg?w=311&h=210&q=85",
+        title: "NBA Trade Rumor Roundup ",
+        primary_image_650x440: "http://img.bleacherreport.net/img/images/photos/001/484/347/326afbbaae76d91b000f6a706700345b_0_original_crop_exact.jpg?w=650&h=440&q=85"
+      },
+      {
+        primary_image_650x440: "http://img.bleacherreport.net/img/images/photos/001/484/172/135247305_crop_exact.jpg?w=650&h=440&q=85",
+        title: "Crabtree and Edwards Steam after Loss",
+        tag: "san-francisco-49ers",
+        permalink: "http://www.csnbayarea.com/blog/niners-talk/post/49ers-frustration-evident-after-loss-to-?blockID=610322",
+        primary_image_311x210: "http://img.bleacherreport.net/img/images/photos/001/484/172/135247305_crop_exact.jpg?w=311&h=210&q=85"
+      },
+      {
+        primary_image_650x440: "http://img.bleacherreport.net/img/images/photos/001/483/828/135507905_crop_exact.jpg?w=650&h=440&q=85",
+        title: "Ask the Experts: Is Carson Palmer the Long-Term Answer for the Raiders?",
+        tag: "oakland-raiders",
+        permalink: "979066-ask-the-experts-is-carson-palmer-the-long-term-answer-for-the-raiders",
+        primary_image_311x210: "http://img.bleacherreport.net/img/images/photos/001/483/828/135507905_crop_exact.jpg?w=311&h=210&q=85"
+      },
+      ...
+    ]
+}
+</pre>
+
+### Ruby Example
+
+<pre>
+BleacherApi::Front.lead_articles(:limit => 2)
+</pre>
+
+### HTTP Example
+
+<pre>
+http://bleacherreport.com/api/front/v2/lead_articles.json?limit=2
+http://bleacherreport.com/api/front/v2/lead_articles.json?tags=san-francisco-49ers,oakland-raiders&devicetype=ipad&appversion=1.4&page=1&perpage=10
+</pre>
+
+<a name="geolocation_teams"></a>
 GET /api/geolocation/teams.json
 -------------------------------
 

data/config/gemspec.yml

@@ -1,5 +1,5 @@
 name: bleacher_api
-version: 0.1.2
+version: 0.1.3
 authors:
   - Bleacher Report
 email: wwelsh@bleacherreport.com

data/lib/bleacher_api.rb

@@ -25,6 +25,14 @@ class BleacherApi
     end
   end
   
+  class Article
+    class <<self
+      def article(id, options={})
+        BleacherApi.call(:get, 'article/article', options.merge(:id => id))
+      end
+    end
+  end
+
   class Authenticate
     class <<self
       def login(email, password, redirect=nil)
@@ -92,4 +100,4 @@ class BleacherApi
       end
     end
   end
-end
+end

data/spec/bleacher_api_spec.rb

@@ -5,6 +5,23 @@ describe BleacherApi do
   before(:all) do
     @user_keys = %w(id email first_name last_name permalink token api)
   end
+
+  if only?(:Article)
+    describe :Article do
+      describe :article do
+        
+        describe 'success' do
+          before(:all) do
+            @response = BleacherApi::Article.article(1020834, :article => true)
+          end
+
+          it "should return a hash with valid keys" do
+            @response.keys.should == ["article"]
+          end
+        end
+      end
+    end
+  end
   
   if only?(:Authenticate)
     describe :Authenticate do
@@ -136,4 +153,4 @@ describe BleacherApi do
       end
     end
   end
-end
+end

metadata

@@ -1,72 +1,64 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bleacher_api
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.1.3
 platform: ruby
-authors: 
+authors:
 - Bleacher Report
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-19 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.5.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 8
-        - 7
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A Ruby Interface to the Bleacher Report API
 email: wwelsh@bleacherreport.com
-executables: 
+executables:
 - bleacher_api
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - LICENSE
 - README.md
@@ -83,37 +75,30 @@ files:
 - spec/fixtures/gemsets.yml
 - spec/fixtures/gemspec.yml
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://bleacherreport.com
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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: 1.3.6
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby Interface to the Bleacher Report API
-test_files: 
+test_files:
 - spec/bleacher_api/gems_spec.rb
 - spec/bleacher_api_spec.rb
 - spec/fixtures/gemsets.yml