pocket-api 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a617b75466441efd28d35e75b2b799a7114292b0
+  data.tar.gz: 0e34bef396c56db192c38d0650009341e41ef525
+SHA512:
+  metadata.gz: 75dd4d2bc98ab42039abf647f9a8a287bb193a8817f282fba6841941a2af4ed417fed2a01c431d58296fd6a532e22d33e451e996ec6c278e8e4a1cf82d9e7711
+  data.tar.gz: 8ffb2b62d7b6efb1744db28055eac59108d18cf3c6a3f43c5919ace0582ac1985d03c6a3fe1edf811e5533d47cebcd7f693925a2b87477f5f3de1921e0b99f59

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Tse-Lin Chu (Wayne Chu)
+
+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,159 @@
+# Pocket Api
+
+Non-official Ruby wrapper for [Pocket API](https://getpocket.com/developer/)
+
+
+## Install
+
+```
+gem install pocket-api
+```
+
+## Usage
+
+### Configuration
+
+```rb
+PocketAPI.configure do |config|
+  config.consumer_key = 'consumer-key'
+end
+```
+
+### Fetch Items (TODO, priority=1)
+
+#### Make request
+
+```rb
+access_token = "UserAccessToken"
+client = PocketAPI::Client.new(access_token)
+items = client.retrieve({ detailType: "simple" }) #=> returns Collection of Items
+```
+
+#### Play with response
+
+```rb
+items.unread #=> Returns PocketAPI::Item Collection with only unread items
+items.archived #=> Returns PocketAPI::Item Collection with only archived items
+items.deleted #=> Returns PocketAPI::Item Collection with only deleted items
+items.where(contentType: "article") #=> Returns PocketAPI::Item Collection with only items tagged as `contentType == "article"`, etc...
+item.tags #=> Returns PocketAPI::Tag Collection
+item.authors #=> Returns PocketAPI::Auther Collection
+item.images #=> Returns PocketAPI::Image Collection
+item.videos #=> Returns PocketAPI::Video Collection
+```
+
+### Create Item (TODO, priority=2)
+
+```rb
+PocketAPI::Item.create!(params)
+#=> PocketAPI::Item
+```
+
+### Update Item (TODO, priority=3)
+
+#### Basic Usage
+
+follow [https://getpocket.com/developer/docs/v3/modify](https://getpocket.com/developer/docs/v3/modify)
+
+```rb
+params = {
+  action: "archive",
+  item_id: "229279689",
+  time: Time.now
+}
+item.update!(params)
+# => true
+```
+
+#### Advance Usage
+
+```rb
+item.archive!(time=nil)
+# => true
+
+item.readd!(time=nil)
+# => true
+
+item.favorite!(time=nil)
+# => true
+
+item.unfavorite!(time=nil)
+# => true
+
+item.delete!(time=nil)
+# => true
+
+item.tags.remove!(['first', 'second'])
+# => true
+
+item.tags.replace!(['first', 'second'])
+# => true
+
+item.tags.clear!(['first', 'second'])
+# => true
+
+item.tags.rename!(old_tag, new_tag)
+# => true
+
+tag = item.tags.first
+tag.rename!('haha')
+# => true
+```
+
+### Errors (TODO, priority=unknown)
+
+[https://getpocket.com/developer/docs/errors](https://getpocket.com/developer/docs/errors)
+
+
+
+## Development
+
+First, Make sure you installed ruby and bundler, and then follow steps below:
+
+```sh
+git clone https://github.com/wayne5540/pocket_api pocket_api
+cd pocket_api
+bundle install
+```
+
+### Autoatically run test in shell
+
+```sh
+bundle exec guard
+```
+
+### Test manually
+
+```sh
+bundle exec rspec
+```
+
+### Run locally
+
+```sh
+gem build build pocket_api.gemspec
+  # =>
+  # Successfully built RubyGem
+  # Name: pocket_api
+  # Version: 0.0.0
+  # File: pocket_api-0.0.0.gem
+gem install pocket_api-0.0.0.gem
+irb
+```
+
+then
+
+```rb
+retuire 'pocket_api'
+# => true
+```
+
+## TODO or not TODO, that is the question...
+
+* Support [limit header](https://getpocket.com/developer/docs/errors)
+* Support [Authentication](https://getpocket.com/developer/docs/authentication)
+* Remove pocket-ruby dependency or add test for it.
+
+## License
+
+See [LICENSE](LICENSE.md)

data/lib/pocket_api.rb

@@ -0,0 +1,13 @@
+require 'pocket_api/configurable'
+require 'pocket_api/item'
+require 'pocket_api/collection'
+require 'pocket_api/client'
+
+module PocketAPI
+  class Error < StandardError; end
+  class InvalidAttributeError < Error; end
+
+  class << self
+    include PocketAPI::Configurable
+  end
+end

data/lib/pocket_api/client.rb

@@ -0,0 +1,15 @@
+module PocketAPI
+  class Client
+    require 'pocket-ruby'
+
+    def initialize(access_token)
+      @client = Pocket.client(access_token: access_token)
+    end
+
+    def retrieve(options={})
+      info = @client.retrieve(options)
+      hashes = info['list'].values
+      Collection.new(Item, hashes)
+    end
+  end
+end

data/lib/pocket_api/collection.rb

@@ -0,0 +1,36 @@
+module PocketAPI
+  class Collection
+    include Enumerable
+    attr_reader :klass
+    attr_accessor :data
+
+    def initialize(klass, hashes=[])
+      @klass = klass
+      @data = parse_hashes(hashes)
+    end
+
+    def each(&block)
+      @data.each{ |o| block.call(o) }
+    end
+
+    def where(key_value)
+      key, value = key_value.first
+
+      raise InvalidAttributeError, "Invalid attribute: #{key}" unless @klass.method_defined? key.to_sym
+
+      dup_select { |o| o.send(key) == value }
+    end
+
+    private
+
+    def dup_select(&block)
+      dup = self.dup
+      dup.data = select(&block)
+      dup
+    end
+
+    def parse_hashes(hashes)
+      hashes.map { |hash| @klass.new(hash) }
+    end
+  end
+end

data/lib/pocket_api/configurable.rb

@@ -0,0 +1,10 @@
+module PocketAPI
+  module Configurable
+    attr_accessor :consumer_key
+
+    def configure
+      yield self
+      Pocket.configure { |config| yield config }
+    end
+  end
+end

data/lib/pocket_api/item.rb

@@ -0,0 +1,40 @@
+module PocketAPI
+  class Item
+    INTEGER_ATTRIBUTES = %w(favorite status word_count has_video has_image)
+    BOOLEAN_ATTRIBUTES = %w(is_article is_index)
+    TIME_ATTRIBUTES = %w(time_added time_updated time_read time_favorited)
+
+    def initialize(hash)
+      hash.each do |name, value|
+        self.class.send(:define_method, "#{name}=".to_sym) do |val|
+          instance_variable_set("@" + name.to_s, val)
+        end
+
+        self.class.send(:define_method, name.to_sym) do
+          instance_variable_get("@" + name.to_s)
+        end
+
+        self.send("#{name}=".to_sym, normalize(name, value))
+      end
+    end
+
+    def id
+      item_id
+    end
+
+    private
+
+    def normalize(name, value)
+      case
+      when INTEGER_ATTRIBUTES.include?(name)
+        value.to_i
+      when BOOLEAN_ATTRIBUTES.include?(name)
+        value.to_i == 1
+      when TIME_ATTRIBUTES.include?(name)
+        value.to_i == 0 ? nil : Time.at(value.to_i)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/pocket_api/version.rb

@@ -0,0 +1,17 @@
+module PocketAPI
+  # Current major release.
+  # @return [Integer]
+  MAJOR = 0
+
+  # Current minor release.
+  # @return [Integer]
+  MINOR = 0
+
+  # Current patch level.
+  # @return [Integer]
+  PATCH = 0
+
+  # Full release version.
+  # @return [String]
+  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
+end

data/pocket-api.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pocket_api/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'pocket-ruby', '~> 0.0.6'
+
+  spec.name = 'pocket-api'
+  spec.version = PocketAPI::VERSION
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.summary = 'Simple wrapper for the Pocket API'
+  spec.description = 'Simple wrapper for the Pocket API (Non-officially)'
+  spec.authors = ['Wayne Chu']
+  spec.email = 'wayne.5540@gmail.com'
+  spec.homepage = 'https://github.com/wayne5540/pocket_api'
+  spec.license = 'MIT'
+  spec.files = %w(README.md LICENSE.md pocket-api.gemspec)
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: pocket-api
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Wayne Chu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pocket-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: Simple wrapper for the Pocket API (Non-officially)
+email: wayne.5540@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/pocket_api.rb
+- lib/pocket_api/client.rb
+- lib/pocket_api/collection.rb
+- lib/pocket_api/configurable.rb
+- lib/pocket_api/item.rb
+- lib/pocket_api/version.rb
+- pocket-api.gemspec
+homepage: https://github.com/wayne5540/pocket_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: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Simple wrapper for the Pocket API
+test_files: []