feedly_api 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43a7715f0add0564eacbedfd563c66f1756b46c7
-  data.tar.gz: 61c1853e5aa7cddfb0514a39a05996650cbb7781
+  metadata.gz: 6b7519c1e6112dda9cd35da6fd2951dda5c047ba
+  data.tar.gz: e3c7d15e7057f90ed01186acb927a8e8d3f40da0
 SHA512:
-  metadata.gz: 9d695edda17f345ad9c2f99c36bf3e78f77a12873ba9745ad7557228ef0b75121ce9ba4d4ae438f868c946dd4c65b1d931f29de76c39243b0b72ae9fa45f19d1
-  data.tar.gz: 5aa2b7af45b8a65b8bff4ce0369f6225b11edc36a73998acfc30b4c783b8796c7970a7034b9e8a640aeacb7279d8a6718980af1a63e541515ac8e1fb95e78bf3
+  metadata.gz: 57e4764514164564323c3b53f75d26debf5fb921485c678860c2832d48cd657fcc5c4d66cc074216b90384c9914be1e5a5a20c03d438a9b6773aaa520a073a64
+  data.tar.gz: b21d6794aa1ae065de8d2c10dc472dbdafe24181c916b792ad23b39990c287a1b8efdf58d96056c265951839509b22146f92b3193503b55d0af58a275ac7ae87

data/LICENSE

@@ -1,13 +1,21 @@
-Copyright 2013 Myuzu
+The MIT License (MIT)
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+Copyright (c) 2014 Myuzu
 
-  http://www.apache.org/licenses/LICENSE-2.0
+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:
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+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

@@ -12,27 +12,14 @@ Early unofficial Feedly API with no external dependencies
 ## Usage
 
 ```ruby
-feedly = FeedlyApi::Client.new 
-=> #<FeedlyApi::Client:0x007ff233308ae0 @auth_token=nil>
-client.get_feed_info 'feed/https://www.eff.org/rss/updates.xml'
-=> {:website=>"https://www.eff.org/rss/updates.xml",
- :id=>"feed/https://www.eff.org/rss/updates.xml",
- :subscribers=>2442,
- :title=>"Deeplinks",
- :velocity=>15.2}
-client.get_feed_contents 'feed/https://www.eff.org/rss/updates.xml'
-=> {:direction=>"ltr",
- :continuation=>"13fa6b1134b:1a10f:eacbe387",
- :alternate=>
-  [{:href=>"https://www.eff.org/rss/updates.xml", :type=>"text/html"}],
- :id=>"feed/https://www.eff.org/rss/updates.xml",
- :updated=>1373935361457,
- :title=>"Deeplinks",
- :items=>
-  [{:id=> 
-  # ...
-client.get_feed_contents('feed/https://www.eff.org/rss/updates.xml', count: 1).size
-=> 1
+# Create client for API requests; OAuth token optional
+@client = FeedlyApi::Client.new
+# Create Feed object for specific feed id
+@feed = @client.feed('feed/https://www.eff.org/rss/updates.xml')
+# Get array of feed items hashes
+@feed.items
+# Pass params to get more or less items
+@feed.items(count: 50)
 ```
 
 ## Supported Ruby Versions

data/feedly_api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/Myuzu/feedly_api'
   s.summary     = %q{Ruby wrapper for Feedly API}
   s.description = %q{Simpe unofficial Feedly API wrapper. No auth yet.}
-  s.license     = 'Apache License, Version 2.0'
+  s.license     = 'MIT License'
 
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ['lib']

data/lib/feedly_api.rb

@@ -13,7 +13,7 @@ module FeedlyApi
   class << self
     def get(url, token)
       uri = URI(url)
-      req = Net::HTTP::Get.new(uri)
+      req = Net::HTTP::Get.new(uri.request_uri)
 
       unless token.nil?
         req['$Authorization.feedly'] = '$FeedlyAuth'

data/lib/feedly_api/client.rb

@@ -15,8 +15,7 @@ module FeedlyApi
     end
 
     def feed(feed_id)
-      data = get_feed_info(feed_id)
-      FeedlyApi::Feed.new data
+      Feed.new(self, feed_id)
     end
 
     private

data/lib/feedly_api/feed.rb

@@ -4,18 +4,29 @@ module FeedlyApi
                 :subscribers,
                 :title,
                 :velocity,
-                :id
+                :id,
+                :client
 
-    def initialize(data)
-      @website     = data.fetch(:website)
-      @subscribers = data.fetch(:subscribers)
-      @title       = data.fetch(:title)
-      @velocity    = data.fetch(:velocity)
-      @id          = data.fetch(:id)
+    def initialize(client = Client.new, feed_id)
+      @client = client
+      @id = feed_id
+
+      fetch_feed_info
+    end
+
+    def items(args = {})
+      @client.get_feed_contents(@id, args).fetch(:items) {[]}
     end
 
-    def items
-      []
+    private
+
+    def fetch_feed_info
+      data = @client.get_feed_info(@id)
+
+      @website     = data.fetch(:website)     { nil }
+      @subscribers = data.fetch(:subscribers) { nil }
+      @title       = data.fetch(:title)       { nil }
+      @velocity    = data.fetch(:velocity)    { nil }
     end
   end
 end

data/lib/feedly_api/version.rb

@@ -1,3 +1,3 @@
 module FeedlyApi
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/spec/lib/feedly_api/client_spec.rb

@@ -1,4 +1,18 @@
 require 'spec_helper'
 
 describe FeedlyApi::Client do
+  let(:auth_token) { ENV['FEEDLY_TOKEN']   || 'GREATE_AUTH_TOKEN' }
+  let(:user_id)    { ENV['FEEDLY_USER_ID'] || '00000000-000-NOT-VALID-a29b6679bb3c' }
+  let(:client)     { FeedlyApi::Client.new(auth_token) }
+  let(:feed_data)  { {website: 'https://www.eff.org/rss/updates.xml', subscribers: 2443,
+    title: 'Deeplinks', velocity: 15.2,
+    id: 'feed/https://www.eff.org/rss/updates.xml' }
+  }
+
+  describe '#feed' do
+    it 'returns Feed object with given feed_id' do
+      feed = client.feed(feed_data[:id])
+      expect(feed.id).to eq feed_data[:id]
+    end
+  end
 end

data/spec/lib/feedly_api/feed_spec.rb

@@ -1,41 +1,23 @@
 require 'spec_helper'
 
 describe FeedlyApi::Feed do
-  let(:feed_data) { {website: 'https://www.eff.org/rss/updates.xml', subscribers: 2443,
-    title: 'Deeplinks', velocity: 15.2,
-    id: 'feed/https://www.eff.org/rss/updates.xml' }
-  }
-  let(:feed) { FeedlyApi::Feed.new(feed_data) }
+  DEFAULT_ITEMS_SIZE = 20
 
-  describe '#new' do
-    it 'stores website' do
-      expect(feed.website).to eq 'https://www.eff.org/rss/updates.xml'
-    end
-
-    it 'stores subscribers' do
-      expect(feed.subscribers).to eq 2443
-    end
-
-    it 'stores title' do
-      expect(feed.title).to eq 'Deeplinks'
-    end
+  let(:auth_token) { ENV['FEEDLY_TOKEN']   || 'GREATE_AUTH_TOKEN' }
+  let(:user_id)    { ENV['FEEDLY_USER_ID'] || '00000000-000-NOT-VALID-a29b6679bb3c' }
+  let(:feed_id)    { 'feed/https://www.eff.org/rss/updates.xml' }
+  let(:feed)       { FeedlyApi::Client.new(auth_token).feed(feed_id) }
 
-    it 'stores velocity' do
-      expect(feed.velocity).to eq 15.2
+  describe '#items' do
+    it 'returns feed items' do
+      expect(feed.items.size).to eq DEFAULT_ITEMS_SIZE
     end
 
-    it 'stores id' do
-      expect(feed.id).to eq 'feed/https://www.eff.org/rss/updates.xml'
+    it 'returns certain amount of feed items' do
+      items = feed.items(count: 2)
+      expect(items.size).to eq 2
     end
-  end
-
-  describe '#items' do
-    it 'returns feed items'
-    # it 'returns feed items' do
-    #   expect(feed.items.size).to eq 20
-    # end
 
-    it 'returns certain amount of feed items'
     it 'returns feed items in certain order'
   end
 end

data/spec/lib/feedly_api_spec.rb

@@ -1,14 +1,13 @@
 require 'spec_helper'
 
 describe FeedlyApi::Client do
-  do_stub = ENV['FEEDLY_API_BYPASS_STUBS'].nil?
-  let(:auth_token) { ENV['FEEDLY_TOKEN'] || 'GREATE_AUTH_TOKEN' }
+  let(:auth_token) { ENV['FEEDLY_TOKEN']   || 'GREATE_AUTH_TOKEN' }
   let(:user_id)    { ENV['FEEDLY_USER_ID'] || '00000000-000-NOT-VALID-a29b6679bb3c' }
   let(:client)     { FeedlyApi::Client.new auth_token }
 
   describe '#new' do
     before :each do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json')))
     end
 
     it 'creates Client object with given token' do
@@ -17,21 +16,21 @@ describe FeedlyApi::Client do
     end
 
     it 'saves user_id' do
-      expect(client.user_id).to eq '00000000-000-NOT-VALID-a29b6679bb3c' #user_id
+      expect(client.user_id).to eq user_id
     end
   end
 
   describe '#get_user_profile' do
     # rewrite for more accurancy
     it 'returns user info' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'profile.json')))
       expect(client.get_user_profile[:client]).to eq 'feedly'
     end
   end
 
   describe '#get_feed_info' do
     it 'retrievs basic feed info' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_info.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_info.json')))
       feed_info = client.get_feed_info('feed/https://www.eff.org/rss/updates.xml')
       expect(feed_info[:website]).to eq 'https://www.eff.org/rss/updates.xml'
     end
@@ -39,20 +38,20 @@ describe FeedlyApi::Client do
 
   describe '#get_subscriptions' do
     it 'retrievs user subscriptions' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'subscriptions.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'subscriptions.json')))
       expect(client.get_subscriptions.size).to eq 3
     end
   end
 
   describe '#get_feed_contents' do
     it 'retrievs feed contents' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_20.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_20.json')))
       feed_contents = client.get_feed_contents('feed/https://www.eff.org/rss/updates.xml')
       expect(feed_contents[:items].size).to eq 20
     end
 
     it 'retrievs custom number of feed items' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_10.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'feed_contents_10.json')))
       feed_contents = client.get_feed_contents('feed/https://www.eff.org/rss/updates.xml', {count: 10})
       expect(feed_contents[:items].size).to eq 10
     end
@@ -64,7 +63,7 @@ describe FeedlyApi::Client do
 
   describe '#get_tag_contents' do
     it 'retrievs content for specific tag' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'tagged.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'tagged.json')))
       feed_contents = client.get_tag_contents('global.saved')
       expect(feed_contents[:items].size).to eq 1
     end
@@ -78,13 +77,13 @@ describe FeedlyApi::Client do
 
   describe '#get_category_contents' do
     it 'retrievs content for custom category_id' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed.json')))
       feed_contents = client.get_category_contents('global.uncategorized')
       expect(feed_contents[:items].size).to eq 16
     end
 
     it 'retrievs custom number of feed items for specific category_id' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed_10.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'uncategoriezed_10.json')))
       feed_contents = client.get_category_contents('global.uncategorized', {count: 10})
       expect(feed_contents[:items].size).to eq 10
     end
@@ -92,15 +91,8 @@ describe FeedlyApi::Client do
 
   describe '#get_markers' do
     it 'returns unred counts for all feeds' do
-      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'markers.json'))) if do_stub
+      FeedlyApi.stub(:get).and_return(File.read(File.join('spec', 'fixtures', 'markers.json')))
       expect(client.get_markers[:unreadcounts].last[:count]).to eq 16
     end
   end
-
-  describe '#feed' do
-    it 'returns Feed object for current feed id' do
-      feed = client.feed('feed/https://www.eff.org/rss/updates.xml')
-      expect(feed).to be_instance_of(FeedlyApi::Feed)
-    end
-  end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: feedly_api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Myuzu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Simpe unofficial Feedly API wrapper. No auth yet.
@@ -72,9 +72,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -104,7 +104,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/Myuzu/feedly_api
 licenses:
-- Apache License, Version 2.0
+- MIT License
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -112,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Feedly API