getpocket 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDBjZWJhYjViMGZiMGU0OGVjYWFhNmM3ZjcxNmQyMzJkMTYyMzBhNA==
+    OWU3ZWE3Yzk0Yjk0ZTI5MDQyMGEzYjI5MWVjYzU4NWFhYzhhMjdiMA==
   data.tar.gz: !binary |-
-    NmJlYzUwZWQxNTMwNjYwZjg3ZTdkOWM3OGRlMDdkMzQ2YzJkZmYwNA==
+    MjhjYWNlMzYxMjZhMGE0ODE2MWE4OWI4ZTc1ZTkzZGY0YzI0NmU4MQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MWNlNzI2ZWRhODc1MDYxNjM5Y2ViODIwNGI0M2NiOTk4N2ViNWMxODNlZWJl
-    MDQyY2FjZmU1NDEzYzIxYjAxNTMyNWIwM2Q0ZjFjNjI5OWRkZTZiNjZlZWYx
-    MTYwZjY2NzVmOTY4ZDQ5OGI0MWJhNWQwZDQxNTIxNjU1ZjQyMjc=
+    Mzc2NmI4MjBkMDYyODdhN2FiN2ExZjRmODY5Mzk5ZTg5MDhlNmI5MDJiMDM4
+    M2JlMzlmNGMxY2I5MzI5NDU4NjQwZTE5Y2RkOTIxMTBjOWNhY2ZmMWE1ZTMy
+    OTcxNDcyY2UwNmE4NmQ2N2ZkNmE2MWI1YWQ1MmZhYjUyZjIyODk=
   data.tar.gz: !binary |-
-    MGY0YjMwYThlYTgwZGE5ZjFkNjZiY2ViZjdmYzk0N2RmZTA3YzlkNzliZTRh
-    ODk0MTMwODc3MDA4YWM4ZmQyYTQyY2FkYzNhYmQ0MjgzYzY0ZjNmN2I5YzY5
-    NGMyMTJiMThiNjE2NTA4MzExNjU4NTYxZjI1OGQ2NTkzY2JlYmU=
+    MGMyZTIyZGQ3ZjY3MGY3MGM1NjJlY2U2NTFhNjcxOTMxZmViMWQzOTlkMjY5
+    MjljOTE4YTI2NWI4NTVhYzgyNGJmNDI2NzE4YjNhNTI4MjIxOTNkYjkxNDBl
+    NWM0MzkyNDJmNWI3OWFiZWI4MTJhNTk5ZDZjOTFjMzY4YWQ4ZmU=

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    getpocket (0.0.2)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    minitest (4.7.4)
+    multi_json (1.7.3)
+    multi_xml (0.5.3)
+    rake (10.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  getpocket!
+  minitest
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Chee
+
+MIT License
+
+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/Rakefile

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

data/getpocket.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+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.name          = "getpocket"
+  spec.version       = PocketApi::VERSION
+  spec.authors       = ["Alex Chee"]
+  spec.email         = ["alexchee11@gmail.com"]
+  spec.description   = %q{API Wrapper for Pocket (was Read It Later)}
+  spec.summary       = %q{API Wrapper for Pocket (was Read It Later)}
+  spec.homepage      = "https://github.com/alexchee/pocket_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_dependency "httparty"
+end

data/lib/pocket_api.rb

@@ -0,0 +1,85 @@
+require 'httparty'
+require "pocket_api/version"
+require "pocket_api/connection"
+
+module PocketApi
+  class <<self
+    attr_accessor :client_key
+    attr_accessor :access_token
+
+    def configure(credentials={})
+      @client_key   = credentials[:client_key]
+      @access_token = credentials[:access_token]
+    end
+    
+    # Retrieve API
+    # Options:
+    # * state
+    #   unread = only return unread items (default)
+    #   archive = only return archived items
+    #   all = return both unread and archived items
+    # * favorite
+    #   0 = only return un-favorited items
+    #   1 = only return favorited items
+    # * tag
+    #   tag_name = only return items tagged with tag_name
+    #   _untagged_ = only return untagged items
+    # * contentType
+    #   article = only return articles
+    #   video = only return videos or articles with embedded videos
+    #   image = only return images
+    # * sort
+    #   newest = return items in order of newest to oldest
+    #   oldest = return items in order of oldest to newest
+    #   title = return items in order of title alphabetically
+    #   site = return items in order of url alphabetically
+    # * detailType
+    #   simple = only return the titles and urls of each item
+    #   complete = return all data about each item, including tags, images, authors, videos and more
+    # * search - search query
+    # * domain - search within a domain
+    # * since - timestamp of modifed items after a date
+    # * count - limit of items to return
+    # * offset - Used only with count; start returning from offset position of results
+    def retrieve(options={})
+      response = request(:get, "/v3/get", {:body => options})
+      response["list"]
+    end
+
+    # Add API
+    # Options:
+    # * title 
+    # * tags - comma-seperated list of tags
+    # * tweet_id - Twitter tweet_id
+    def add(url, options={})
+      request(:post, '/v3/add', :body => {:url => url}.merge(options))
+    end
+    
+    # Modify API
+    # Actions:
+    # * add
+    # * archive
+    # * readd - re-add
+    # * favorite
+    # * unfavorite
+    # * delete
+    # * tags_add 
+    # * tags_remove
+    # * tags_replace
+    # * tags_clear
+    # * tags_rename
+    def modify(action, options={})
+      request(:post, '/v3/send', :body => {:action => action}.merge(options))
+    end
+    
+    
+    def request(method, *arguments)
+      arguments[1] ||= {}
+      arguments[1][:body] ||= {}
+      arguments[1][:body] = MultiJson.dump(arguments[1][:body].merge({:consumer_key => @client_key, :access_token => @access_token}))
+      puts arguments.inspect
+      Connection.__send__(method.downcase.to_sym, *arguments)
+    end
+    
+  end # <<self
+end

data/lib/pocket_api/connection.rb

@@ -0,0 +1,45 @@
+module PocketApi
+  class Connection
+    include HTTParty
+    base_uri 'https://getpocket.com'
+    headers "Content-Type" => "application/json; charset=UTF-8"
+    headers "X-Accept" => "application/json"
+
+    class <<self
+      attr_accessor :client_key
+      attr_accessor :request_token
+
+      #####################################################
+      # OAuth authorization Helpers
+      # Sample Workflow:
+      # 1. generate_authorize_url, redirect user to URL
+      # 2. generate_access_token if user comes back
+      # 3. Do a sample call to API to see if it works
+      #####################################################
+      def generate_request_token(body_options={}, headers_options={})
+        response = post("/v3/oauth/request", {:body => MultiJson.dump({:consumer_key => @client_key}.merge(body_options)), :headers => {"Content-Type" => "application/json; charset=UTF-8", "X-Accept" => "application/json"}.merge(headers_options)})
+        if response.success? && response.parsed_response["code"]
+          # Should be a string body like "code=12345678"
+          @request_token = response.parsed_response["code"]
+        else
+          raise "could not generate request token: #{response.inspect}"
+        end
+      end
+      
+      def generate_access_token(request_token)
+        response = post("/auth/authorize", {:body => MultiJson.dump({:code => @request_token, :consumer_key => @client_key}), :headers => {"Content-Type" => "application/json; charset=UTF-8", "X-Accept" => "application/json"}})
+        response.parsed_response["access_token"]
+      end
+      
+      def generate_authorize_url(redirect_uri, failed_uri=nil, state=nil)
+        failed_uri ||= redirect_uri
+        @request_token = generate_request_token({:redirect_uri => failed_uri})
+        
+        "#{default_options[:base_uri]}/v3/oauth/request?request_token=#{CGI.escape(request_token)}&redirect_uri=#{CGI.escape(redirect_uri)}#{"&state=#{CGI.escape(state)}"if state}"
+      end
+      
+    end # <<self
+    
+    
+  end
+end

data/lib/pocket_api/version.rb

@@ -0,0 +1,3 @@
+module PocketApi
+  VERSION = "0.0.2"
+end

data/tests/test_pocket_api.rb

@@ -0,0 +1,33 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pocket_api'
+
+describe PocketApi do
+  describe "configure" do
+    it "sets client_key and access_token" do
+      PocketApi.configure(:client_key => "mykey", :access_token => "myat")
+      PocketApi.client_key.must_equal "mykey"
+      PocketApi.access_token.must_equal "myat"
+    end
+  end
+  
+  describe "request" do
+    it "should convert :body of argument into JSON"
+    it "should insert consumer_key and access_token into argument :body"
+    it "should call Connection.get"
+    it "should call Connection.post"
+  end
+
+  describe "retrieve" do
+  end
+
+  describe "add" do
+  end
+
+  describe "modify" do
+  end
+  
+end

data/tests/test_pocket_api_connection.rb

@@ -0,0 +1,35 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pocket_api'
+
+describe PocketApi::Connection do
+  it "sets default base_uri to https://getpocket.com" do
+    PocketApi::Connection.base_uri.must_equal "https://getpocket.com"
+  end
+  
+  it "sets default Content-Type and X-Accept headers for application/json" do
+    default_headers = PocketApi::Connection.default_options[:headers]
+    default_headers["Content-Type"].wont_be_nil
+    default_headers["Content-Type"].must_match /^application\/json/
+    default_headers["X-Accept"].wont_be_nil
+    default_headers["X-Accept"].must_match /^application\/json/
+  end
+
+  describe "generate_request_token" do
+    it "returns params :code if response success"
+    it "raises error if response not success or params :code is missing"
+  end
+
+  describe "generate_access_token" do
+    it "returns params :code if response success"
+    it "raises error if response not success or params :code is missing"
+  end
+  
+  describe "generate_authorize_url" do
+    it "return https://getpocket.com/v3/oauth/request with params request token and redirect_uri"
+    it "return https://getpocket.com/v3/oauth/request with params request token, redirect_uri, and state"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getpocket
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Chee
@@ -74,7 +74,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- getpocket.gemspec
+- lib/pocket_api.rb
+- lib/pocket_api/connection.rb
+- lib/pocket_api/version.rb
+- tests/test_pocket_api.rb
+- tests/test_pocket_api_connection.rb
 homepage: https://github.com/alexchee/pocket_api
 licenses:
 - MIT