f00px 0.3.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Arthur Neves
+
+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/README.md

@@ -0,0 +1,40 @@
+# F00px
+
+500px api ruby gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'f00px'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install f00px
+
+## Usage
+
+Add this code to some initializer:
+
+    F00px.configure do |config|
+        config.consumer_key = __consumer_key__
+        config.consumer_secret = __consumer_secret__
+        config.token = __token__
+        config.token_secret = __token_secret__
+    end
+
+Then just use the api:
+
+    response = F00px.get('/users/1')
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,35 @@
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rspec/core/rake_task"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "f00px/version"
+
+task :gem => :build
+task :build do
+  system "gem build f00px.gemspec"
+end
+
+task :install => :build do
+  system "gem install f00px-#{F00px::VERSION}.gem"
+end
+
+task :release => :build do
+  system "git tag -a v#{F00px::VERSION} -m 'Tagging #{F00px::VERSION}'"
+  system "git push --tags"
+  system "gem push f00px-#{F00px::VERSION}.gem"
+  system "rm f00px-#{F00px::VERSION}.gem"
+end
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/f00px.rb

@@ -0,0 +1,33 @@
+require "f00px/version"
+require "cgi"
+require "faraday_middleware"
+require "typhoeus"
+require "typhoeus/adapters/faraday"
+require "f00px/error"
+require "f00px/authentication"
+require "f00px/configuration"
+require "f00px/connection"
+require "f00px/request"
+require "f00px/client"
+
+module F00px
+
+  class << self
+
+    include Configuration
+
+    def client
+      @client ||= F00px::Client.new
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+
+
+end

data/lib/f00px/authentication.rb

@@ -0,0 +1,36 @@
+module F00px
+  module Authentication
+
+    def xauth(username, password)
+      unless token? && token_secret?
+        begin
+          response = post('oauth/request_token')
+          parse_oauth_response(response)
+
+          params = { x_auth_mode: "client_auth", x_auth_username: username, x_auth_password: password}
+          response = post("oauth/access_token", params)
+          parse_oauth_response(response)
+        rescue F00px::Error => e
+          self.token = self.token_secret =  nil
+          raise e
+        end
+      end
+    end
+
+    private
+    def parse_oauth_response(response)
+      unless response.status == 200
+        raise F00px::Error.from_response(response)
+      end
+
+      hash = CGI.parse(response.body).inject({}) do |h, (k,v)|
+        h[k.strip.to_sym] = v.first
+        h
+      end
+
+      self.token = hash[:oauth_token]
+      self.token_secret = hash[:oauth_token_secret]
+    end
+
+  end
+end

data/lib/f00px/client.rb

@@ -0,0 +1,21 @@
+module F00px
+
+  class Client
+    include Authentication
+    include Configuration
+    include Connection
+    include Request
+
+    def self.configure(&block)
+      Client.new.configure(&block)
+    end
+
+    def initialize(options = {})
+      F00px::Configuration.options.each do |key|
+        settings[key] = options[key] || F00px.__send__("#{key}".to_sym)
+      end
+    end
+
+
+  end
+end

data/lib/f00px/configuration.rb

@@ -0,0 +1,35 @@
+require "f00px/configuration/options"
+
+module F00px
+  module Configuration
+    extend self
+    include Options
+
+    option :endpoint, default: 'https://api.500px.com'
+    option :api_version, default: 'v1'
+    option :middleware, default: ::FaradayMiddleware::OAuth
+    option :consumer_key
+    option :consumer_secret
+    option :token
+    option :token_secret
+    option :logger
+    option :user_id
+
+    def self.included(base)
+    end
+
+    def configure
+      yield(self) if block_given?
+      self
+    end
+
+    def credentials
+      { :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :token => token,
+        :token_secret => token_secret
+      }
+    end
+
+  end
+end

data/lib/f00px/configuration/options.rb

@@ -0,0 +1,48 @@
+module F00px
+  module Configuration
+    module Options
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        def defaults
+          @defaults ||= {}
+        end
+
+        def options
+          self.defaults.keys
+        end
+
+        def option(name, options = {})
+          self.defaults[name] = options[:default]
+
+          class_eval <<-RUBY
+            def #{name}
+              settings['#{name}'.to_sym] || #{self}.defaults['#{name}'.to_sym]
+            end
+
+            def #{name}=(value)
+              settings['#{name}'.to_sym] = value
+            end
+
+            def #{name}?
+              !!#{name}
+            end
+          RUBY
+        end
+
+      end
+
+      def reset
+        settings.replace(defaults)
+      end
+
+      def settings
+        @settings ||= {}
+      end
+    end
+  end
+end

data/lib/f00px/connection.rb

@@ -0,0 +1,40 @@
+module F00px
+  module Connection
+
+    def connection
+      options = {
+        headers: {'Accept' => "application/json"},
+        url: "#{endpoint}/#{api_version}"
+      }
+
+      Faraday.new(options) do |builder|
+
+        if middleware?
+          args = Array(middleware)
+          if args.first == ::FaradayMiddleware::OAuth
+            tokens = credentials.dup
+            tokens.merge!(args.last) if args.length > 1
+            builder.use(args.first, tokens)
+          else
+            builder.use(*middleware)
+          end
+        end
+
+        builder.request :url_encoded
+
+#        builder.response :json, content_type: /\bjson$/
+
+        builder.use Faraday::Response::Logger, logger if logger?
+
+        builder.adapter connection_adapter
+      end
+    end
+
+    private
+
+    def connection_adapter
+      :typhoeus
+    end
+
+  end
+end

data/lib/f00px/error.rb

@@ -0,0 +1,36 @@
+module F00px
+  class Error < StandardError
+
+    class << self
+
+      def register_error(error)
+        @errors ||= {}
+        @errors[error::STATUS_CODE] = error
+      end
+
+      def from_response(response)
+        klass = @errors[response.status] || self
+        klass.new(parse_error(response.body))
+      end
+
+      def parse_error(body)
+        return body if body.is_a? String
+        if body.nil?
+          ''
+        elsif body[:error]
+          body[:error]
+        elsif body[:errors]
+          first = Array(body[:errors]).first
+          if first.is_a?(Hash)
+            first[:message].chomp
+          else
+            first.chomp
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'f00px/error/forbidden'
+require 'f00px/error/unauthorized'

data/lib/f00px/error/forbidden.rb

@@ -0,0 +1,10 @@
+module F00px
+  class Error
+
+    class Forbidden < F00px::Error
+      STATUS_CODE = 403
+    end
+
+    register_error(Forbidden)
+  end
+end

data/lib/f00px/error/unauthorized.rb

@@ -0,0 +1,11 @@
+module F00px
+  class Error
+
+    class Unauthorized < F00px::Error
+      STATUS_CODE = 401
+    end
+
+    register_error(Unauthorized)
+
+  end
+end

data/lib/f00px/request.rb

@@ -0,0 +1,32 @@
+require 'f00px/request/callback'
+require 'f00px/request/runner'
+
+module F00px
+  module Request
+
+    def queue(&block)
+      queue = Request::Runner.new(connection)
+      queue.user_id = user_id if user_id?
+      queue.consumer_key = consumer_key if consumer_key?
+      yield(queue)
+      queue.run!
+    end
+
+    def get(url, params = {})
+      queue do |q|
+        q.get(url, params).complete do |response|
+          return response
+        end
+      end
+    end
+
+    def post(url, params = {})
+      queue do |q|
+        q.post(url, params).complete do |response|
+          return response
+        end
+      end
+    end
+
+  end
+end

data/lib/f00px/request/callback.rb

@@ -0,0 +1,70 @@
+module F00px
+  module Request
+    class Callback
+
+      attr_reader :method, :url, :params
+
+      def initialize(method, url, params={})
+        @method, @url, @params = [method, url, params]
+      end
+
+      def info
+        [method, url, params]
+      end
+
+      def perform(response)
+        if response.status != 200
+          on_error!(response)
+        else
+          on_success!(response)
+        end
+
+        on_complete!(response)
+      end
+
+      # Registers an error callback. The callback will be executed if any 400 or 500 HTTP status is returned.
+      #
+      #  PxApi.get('/photos').
+      #   error{|res| puts "HTTP Status: #{res.status}" }
+      def error(&block)
+        @on_error = block
+        self
+      end
+      alias_method :on_error, :error
+
+      # Registers a success callback. This will be triggered if the status code is not 4xx or 5xx.
+      def success(&block)
+        @on_success = block
+        self
+      end
+      alias_method :on_success, :success
+
+      # Register a complete callback. This will be triggered after success or error on all requests.
+      def complete(&block)
+        @on_complete = block
+        self
+      end
+      alias_method :on_complete, :complete
+
+      private
+
+      def on_error!(response)
+        if @on_error.respond_to?(:call)
+          @on_error.call response
+        end
+      end
+
+      def on_success!(response)
+        if @on_success.respond_to?(:call)
+          @on_success.call response
+        end
+      end
+
+      def on_complete!(response)
+        if @on_complete.respond_to?(:call)
+          @on_complete.call response
+        end
+      end
+    end
+  end
+end

data/lib/f00px/request/runner.rb

@@ -0,0 +1,56 @@
+module F00px
+  module Request
+    class Runner
+      attr_accessor :user_id, :consumer_key
+
+      def initialize(conn)
+        @queued_requests = []
+        @connection = conn
+      end
+
+      def get(url, params={})
+        request(:get, url, params)
+      end
+
+      # Queues a POST request
+      def post(url, params={})
+        request(:post, url, params)
+      end
+
+      def request(method, url, params = {})
+        params = params.dup
+        params[:consumer_key] = consumer_key
+
+        Callback.new(method, url, params).tap do |r|
+          @queued_requests << r
+        end
+      end
+
+      # Runs all queued requests. This method will block until all requests are complete.
+      # As requests complete their callbacks will be executed.
+      def run!
+        conn = @connection
+
+        responses = {}
+        conn.in_parallel do
+          @queued_requests.each do |callback|
+            method, url, params = callback.info
+            params ||= {}
+            params[:auth_user_id] = user_id if user_id
+
+            response = conn.run_request(method, url, params, {})
+
+            response.on_complete do
+              callback.perform(response)
+            end
+
+          end
+        end
+
+      ensure
+        @queued_requests = []
+      end
+
+    end
+  end
+end

data/lib/f00px/version.rb

@@ -0,0 +1,3 @@
+module F00px
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: f00px
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Arthur Neves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: ''
+email:
+- arthurnn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/f00px/authentication.rb
+- lib/f00px/client.rb
+- lib/f00px/configuration/options.rb
+- lib/f00px/configuration.rb
+- lib/f00px/connection.rb
+- lib/f00px/error/forbidden.rb
+- lib/f00px/error/unauthorized.rb
+- lib/f00px/error.rb
+- lib/f00px/request/callback.rb
+- lib/f00px/request/runner.rb
+- lib/f00px/request.rb
+- lib/f00px/version.rb
+- lib/f00px.rb
+- LICENSE
+- README.md
+- Rakefile
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: f00px
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: 500px api rubygem
+test_files: []