croudia 0.0.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb3a0686cfdaa7c6f90d6e512c28a40f6367a6cb
+  data.tar.gz: 8350f383e5f846169b696c6653afd805f6498c16
+SHA512:
+  metadata.gz: 1fe3050abdbbd48263071db6435d669386ee2b846739d07db79498525653934aeaff6d24b3aa9ec95b089773affbad8cd0150af9002882fda7b2372a8d577372
+  data.tar.gz: f2f081a62a57f4e20267c9d141eac2138ecc95067240b88466d6b5584ce65ed3c7bdb252c1d70ccd00a0587c424ca9b88767e5e4e35955f3ffb13dd40adb36f6

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.env
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -15,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle

data/README.md

@@ -1,6 +1,6 @@
 # Croudia
 
-A Mechanize-based scraper for [Croudia](https://croudia.com)
+A Ruby Wapper for the [Croudia](https://croudia.com) API
 
 ## Installation
 
@@ -18,24 +18,41 @@ Or install it yourself as:
 
 ## Usage
 
-```ruby
-require 'croudia'
+### Getting an access token
 
-# Create a new instance
-croudia = Croudia.new('username', 'password')
+``` ruby
+require "croudia"
 
-# Same as above
-croudia = Croudia.new
-croudia.login('username', 'password')
+# Initialize a new instance
+croudia = Croudia::Client.new(
+  client_id: "client_id",
+  client_secret: "client_secret"
+)
 
-# Update status
-croudia.update('Hello!')
+# Get URL
+url = croudia.authorize_url
 
-# Follow @wktk
-croudia.follow('wktk')
+# Or add scope query in URL
+url = croudia.authrorize_url(scope: "scope_value")
 
-# Get the home timeline
-croudia.timeline
+# Retrieve an access token
+access_token = croudia.get_access_token("code param returned by user")
+#=> { "access_token" => " ... ", "refresh_token" => " ... ", ... }
+```
+
+### Using the API
+
+``` ruby
+require "croudia"
+
+# Create an instance
+croudia = Croudia::Client.new(access_token: "access_token")
+
+# Get home_timeline
+home_timeline = croudia.home_timeline
+
+# Post a status
+posted_status = croudia.update("Hello!")
 ```
 
 ## Contributing

data/Rakefile

@@ -1,11 +1,11 @@
-#!/usr/bin/env rake
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rspec_opts = ['-cfs']
-end
-
-task :default => :spec
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['-cfs']
+end
+
+task :default => :spec

data/croudia.gemspec

@@ -3,9 +3,9 @@ require File.expand_path('../lib/croudia/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['wktk']
-  gem.email         = ['wktk@wktk.in']
-  gem.description   = 'A Mechanize-based scraper for Croudia'
-  gem.summary       = 'Croudia scraper'
+  gem.email         = ['mail@wktk.jp']
+  gem.description   = 'Ruby Wrapper for the Croudia API'
+  gem.summary       = 'Croudia API'
   gem.homepage      = 'https://github.com/wktk/croudia-gem'
 
   gem.files         = `git ls-files`.split($\)
@@ -15,9 +15,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Croudia::VERSION
 
-  gem.add_dependency 'mechanize', '~> 2.5.1'
-  gem.add_development_dependency 'rake', '~> 0.9.2.2'
-  gem.add_development_dependency 'rdoc', '~> 3.12'
-  gem.add_development_dependency 'rspec', '~> 2.12.0'
-  gem.add_development_dependency 'webmock', '~> 1.8.7'
+  gem.add_dependency 'faraday', '~> 0.8.7'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.0'
+  gem.add_dependency 'hashie', '~> 2.0.5'
+  gem.add_development_dependency 'rake', '~> 10.1.0'
+  gem.add_development_dependency 'rdoc', '~> 4.0.1'
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_development_dependency 'webmock', '~> 1.13.0'
 end

data/lib/croudia/api/favorites.rb

@@ -0,0 +1,43 @@
+require 'croudia/status'
+
+module Croudia
+  module API
+    module Favorites
+      # Favorite a status
+      #
+      # @param status_id [String, Integer, Croudia::Status]
+      # @param params [Hash]
+      # @return [Croudia::Status] Favorited status
+      def favorite(status_id, params={})
+        case status_id
+        when String, Integer
+        when Croudia::Status
+          status_id = status_id.id_str
+        else
+          raise ArgumentError, 'status_id is invalid'
+        end
+
+        resp = post("/favorites/create/#{status_id}.json", params)
+        Croudia::Status.new(resp)
+      end
+
+      # Unfavorite a status
+      #
+      # @param status_id [String, Integer, Croudia::Status]
+      # @param params [Hash]
+      # @return [Croudia::Status] Unfavorited status
+      def unfavorite(status_id, params={})
+        case status_id
+        when String, Integer
+        when Croudia::Status
+          status_id = status_id.id_str
+        else
+          raise ArgumentError, 'status_id is invalid'
+        end
+        
+        resp = delete("/favorites/destroy/#{status_id}.json", params)
+        Croudia::Status.new(resp)
+      end
+    end
+  end
+end

data/lib/croudia/api/oauth.rb

@@ -0,0 +1,32 @@
+module Croudia
+  module API
+    module OAuth
+      # Authorize URL
+      #
+      # @return authorize_url [String]
+      def authorize_url(params={})
+        params[:client_id] ||= @client_id
+        params[:response_type] ||= 'code'
+        connection.build_url('/oauth/authorize', params).to_s.sub(/^https/, 'http')
+      end
+
+      # Retrieve access_token
+      #
+      # @param code [String] Authorize code passed from user
+      # @params params [Hash] Additional params
+      # @return access_token [Hash]
+      def get_access_token(code, params={})
+        case code
+        when String, Integer
+          params[:code] ||= code
+        when Hash
+          params = code.merge(params)
+        end
+        params[:client_id] ||= @client_id
+        params[:client_secret] ||= @client_secret
+        params[:grant_type] ||= 'authorization_code'
+        post('/oauth/token', params)
+      end
+    end
+  end
+end

data/lib/croudia/api/statuses.rb

@@ -0,0 +1,55 @@
+require 'croudia/status'
+
+module Croudia
+  module API
+    module Statuses
+      # Update status
+      #
+      # @param status [String] Status text
+      # @param params [Hash] Additional params
+      # @return status [Croudia::Status] Posted status
+      def update(status, params={})
+        case status
+        when String
+          params[:status] ||= status
+        when Hash
+          params = status.merge(params)
+        end
+
+        resp = post('/statuses/update.json', params)
+        Croudia::Status.new(resp)
+      end
+
+      # Destroy a status
+      #
+      # @param status_id [String, Integer, Croudia::Status] Status to delete
+      # @param params [Hash]
+      # @return [Croudia::Status] Deleted status
+      def destroy_status(status_id, params={})
+        case status_id
+        when String, Integer
+        when Croudia::Status
+          status_id = status_id.id_str
+        end
+
+        post("/statuses/destroy/#{status_id}.json", params)
+      end
+
+      # Retrieve a status
+      #
+      # @param status_id [String, Integer, Croudia::Status]
+      # @param params [Hash]
+      # @return [Croudia::Status]
+      def status(status_id, params={})
+        case status_id
+        when String, Integer
+        when Croudia::Status
+          status_id = status_id.id_str
+        end
+
+        resp = get("/statuses/show/#{status_id}.json", params)
+        Croudia::Status.new(resp)
+      end
+    end
+  end
+end

data/lib/croudia/api/timelines.rb

@@ -0,0 +1,57 @@
+require 'croudia/status'
+
+module Croudia
+  module API
+    module Timelines
+      # Public Timeline
+      #
+      # @param params [Hash] Additional params
+      # @return [Array<Croudia::Status>]
+      def public_timeline(params={})
+        resp = get('/statuses/public_timeline.json', params)
+        objectify_statuses(resp)
+      end
+
+      # Home Timeline
+      #
+      # @params params [Hash]
+      # @return [Array<Croudia::Status>]
+      def home_timeline(params={})
+        resp = get('/statuses/home_timeline.json', params)
+        objectify_statuses(resp)
+      end
+
+      # User Timeline
+      #
+      # @param user [String, Integer, Croudia::User]
+      # @param params [Hash]
+      # @return [Array<Croudia::Status>
+      def user_timeline(user, params={})
+        case user
+        when String
+          params[:screen_name] ||= user
+        when Integer
+          params[:user_id] ||= user
+        when Croudia::User
+          params[:user_id] ||= user.id_str
+        when Hash
+          params = user.merge(params)
+        end
+
+        resp = get('/statuses/user_timeline.json', params)
+        objectify_statuses(resp)
+      end
+
+      def mentions(params={})
+        resp = get('/statuses/mentions.json', params)
+        objectify_statuses(resp)
+      end
+      alias mentions_timeline mentions
+
+    private
+      def objectify_statuses(statuses)
+        statuses.map { |status| Croudia::Status.new(status) }
+      end
+    end
+  end
+end

data/lib/croudia/base.rb

@@ -0,0 +1,44 @@
+module Croudia
+  class Base
+    class << self
+      def attr_reader(*attrs)
+        mod = Module.new do
+          attrs.each do |attr|
+            define_method(attr) do
+              @attrs[attr.to_sym]
+            end
+            define_method("#{attr}?") do
+              !!@attrs[attr.to_sym]
+            end
+          end
+        end
+        const_set(:Attributes, mod)
+        include mod
+      end
+    end
+
+    # Initialize a new object
+    #
+    # @param attrs [Hash]
+    # @return [Croudia::Base]
+    def initialize(attrs = {})
+      @attrs = attrs || {}
+    end
+
+    # Fetch an attribute
+    #
+    # @param name [String, Symobol]
+    def [](name)
+      __send__(name.to_sym)
+    rescue NoMethodError
+      nil
+    end
+    
+    # @return [Hash]
+    def attrs
+      @attrs
+    end
+    alias to_h attrs
+    alias to_hash attrs
+  end
+end

data/lib/croudia/client.rb

@@ -0,0 +1,64 @@
+require 'croudia/api/favorites'
+require 'croudia/api/oauth'
+require 'croudia/api/statuses'
+require 'croudia/api/timelines'
+require 'croudia/configurable'
+require 'croudia/ext/openssl'
+require 'croudia/version'
+require 'faraday'
+
+module Croudia
+  class Client
+    include Croudia::API::Favorites
+    include Croudia::API::OAuth
+    include Croudia::API::Statuses
+    include Croudia::API::Timelines
+    include Croudia::Configurable
+
+    # Initialize a new Client object
+    #
+    # @param options [Hash]
+    # @return [Croudia::Client]
+    def initialize(options={})
+      Croudia::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Croudia.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={})
+      request(:post, path, params)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, params={})
+      request(:put, path, params)
+    end
+
+  private
+
+    def request(method, path, params={})
+      connection.send(method.to_sym, path, params) do |request|
+        request.headers[:authorization] = "Bearer #{@access_token}" if @access_token
+        request.headers[:content_type] = 'application/x-www-form-urlencoded; charset=utf-8'
+      end.body
+    end
+
+    # Return a Faraday::Connection objet
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(@endpoint, @connection_options.merge(builder: @middleware))
+    end
+  end
+end

data/lib/croudia/configurable.rb

@@ -0,0 +1,39 @@
+require 'croudia/default'
+
+module Croudia
+  module Configurable
+    attr_writer :client_secret, :access_token
+    attr_accessor :client_id, :endpoint, :connection_options, :middleware
+
+    class << self
+      def keys
+        @keys ||= [
+          :endpoint,
+          :connection_options,
+          :middleware,
+          :client_id,
+          :client_secret,
+          :access_token,
+        ]
+      end
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+    def reset!
+      Croudia::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Croudia::Default.options[key])
+      end
+    end
+    alias setup reset!
+
+    def options
+      Hash[Croudia::Configurable.keys.map do |key|
+        [key, instance_variable_get(:"@#{key}")]
+      end]
+    end
+  end
+end

data/lib/croudia/creatable.rb

@@ -0,0 +1,9 @@
+require 'time'
+
+module Croudia
+  module Creatable
+    def created_at
+      @created_at ||= Time.parse(@attrs[:created_at])
+    end
+  end
+end

data/lib/croudia/default.rb

@@ -0,0 +1,63 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'croudia/configurable'
+
+module Croudia
+  module Default
+    ENDPOINT = 'https://api.croudia.com' unless defined? Croudia::Default::ENDPOINT
+    CONNECTION_OPTIONS = {
+      headers: {
+        accept: 'application/json',
+        user_agent: "Croudia Ruby Gem/#{Croudia::VERSION}",
+      },
+      request: {
+        open_timeout: 5,
+        timeout: 10,
+      },
+      ssl: {
+        verify: true,
+      },
+    } unless defined? Croudia::Default::CONNECTION_OPTIONS
+    MIDDLEWARE = Faraday::Builder.new do |builder|
+      builder.request :url_encoded
+
+      builder.response :mashify
+      builder.response :json
+      builder.response :raise_error
+
+      builder.adapter :net_http
+    end unless defined? Croudia::Default::MIDDLEWARE
+
+    class << self
+      def options
+        Hash[Croudia::Configurable.keys.map do |key|
+          [key, __send__(key)]
+        end]
+      end
+
+      def client_id
+        ENV['CROUDIA_CLIENT_ID']
+      end
+
+      def client_secret
+        ENV['CROUDIA_CLIENT_SECRET']
+      end
+
+      def access_token
+        ENV['CROUDIA_ACCESS_TOKEN']
+      end
+
+      def endpoint
+        ENDPOINT
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      def middleware
+        MIDDLEWARE
+      end
+    end
+  end
+end

data/lib/croudia/ext/openssl.rb

@@ -0,0 +1,19 @@
+require 'openssl'
+
+class OpenSSL::SSL::SSLSocket
+  # As of writing, https://api.croudia.com returns a valid cert for 
+  # "croudia.com", but not for "api.croudia.com".  When the original check
+  # process fails with "api.croudia.com", recheck as "croudia.com" and catch
+  # the error if it looks valid.
+  alias_method :croudia_original_pcc, :post_connection_check
+
+  def post_connection_check(hostname)
+    croudia_original_pcc(hostname)
+  rescue OpenSSL::SSL::SSLError => e
+    if hostname == 'api.croudia.com'
+      croudia_original_pcc('croudia.com')
+    else
+      raise e
+    end
+  end
+end

data/lib/croudia/identity.rb

@@ -1,39 +1,22 @@
-module Croudia
-  class Identity
-    attr_reader :id, :time
-    alias id_str id
-    alias created_at time
-
-    def initialize(attrs)
-      attrs.keys.each do |key|
-        if 'time' == key.to_s && !attrs[key].is_a?(Time)
-          if /^\d+$/ =~ attrs[key]
-            attrs[key] = Time.at(attrs[key].to_i)
-          else
-            attrs[key] = Time.new(*attrs[key].split(/\D/))
-          end
-        elsif /_count$/ =~ key.to_s
-          attrs[key] = attrs[key].to_i
-        end
-
-        instance_variable_set(:"@#{key}", attrs[key])
-      end
-    end
-
-    def ==(other)
-      super || self.class == other.class && @id == other.id
-    end
-
-    def [](name)
-      instance_variable_get(:"@#{name}")
-    end
-
-    def id
-      @id
-    end
-
-    def method_missing(name, *args)
-      self[name]
-    end
-  end
-end
+require 'croudia/base'
+
+module Croudia
+  class Identity < Croudia::Base
+    def initialize(*)
+      super
+      raise ArgumentError, 'argument must have an :id key' unless id
+      @attrs[:id_str] = id.to_s
+    end
+
+    # @param other [Croudia::Identity]
+    # @return [Boolean]
+    def ==(other)
+      super || self.class == other.class && id == other.id
+    end
+
+    # @return [Integer]
+    def id
+      @attrs[:id]
+    end
+  end
+end

data/lib/croudia/status.rb

@@ -0,0 +1,26 @@
+require 'croudia/creatable'
+require 'croudia/identity'
+require 'croudia/user'
+
+module Croudia
+  class Status < Croudia::Identity
+    include Croudia::Creatable
+
+    attr_reader :favorited, :favorite_count,
+      :in_reply_to_screen_name, :in_reply_to_status_id_str,
+      :in_reply_to_status_id, :in_reply_to_user_id_str,
+      :in_reply_to_user_id, :spread_count,
+      :play_spread, :play_spread_status, :reply_status, :source,
+      :text, :user
+
+    def initialize(attrs={})
+      user = attrs.delete(:user)
+      pss = attrs.delete(:play_spread_status)
+      reply_status = attrs.delete(:reply_status)
+      super(attrs)
+      @attrs[:user] = Croudia::User.new(user) if user
+      @attrs[:play_spread_status] = Croudia::Status.new(pss) if pss
+      @attrs[:reply_status] = Croudia::Status.new(reply_status) if reply_status
+    end
+  end
+end