dialers 0.1.0

data/lib/dialers/short_circuits_collection.rb

@@ -0,0 +1,27 @@
+module Dialers
+  class ShortCircuitsCollection
+    ResponseLambda = -> (_response) { nil }
+
+    def initialize
+      self.collection = []
+    end
+
+    def add(options)
+      collection << Dialers::ShortCircuit.new(options.fetch(:if), options.fetch(:do))
+    end
+
+    def search_for_stops(response)
+      short_circuit = collection.find do |item|
+        item.can_stop?(response)
+      end
+
+      if !short_circuit.nil?
+        short_circuit.stop(response)
+      end
+    end
+
+    private
+
+    attr_accessor :collection
+  end
+end

data/lib/dialers/status.rb

@@ -0,0 +1,82 @@
+module Dialers
+  # A wrapper over an HTTP status to answer some questions related to what a state means.
+  class Status
+    def initialize(status)
+      self.status = status
+    end
+
+    # @param code [Fixnum] The code to compare
+    # @return [Boolean] wether the status is the argument
+    def is?(code)
+      status.to_i == code.to_i
+    end
+
+    # @return [Boolean] wether the status is a 2xx one.
+    def success?
+      initial_letter == "2"
+    end
+
+    # @return [Boolean] wether the status is a 3xx one.
+    def redirect?
+      initial_letter == "3"
+    end
+
+    # @return [Boolean] wether the status is a 4xx one.
+    def client_error?
+      initial_letter == "4"
+    end
+
+    # @return [Boolean] wether the status is a 5xx one.
+    def server_error?
+      initial_letter == "5"
+    end
+
+    # @return [Boolean] wether the status is 200.
+    def ok?
+      is?(200)
+    end
+
+    # @return [Boolean] wether the status is 201.
+    def created?
+      is?(201)
+    end
+
+    # @return [Boolean] wether the status is 202.
+    def accepted?
+      is?(202)
+    end
+
+    # @return [Boolean] wether the status is 204.
+    def no_content?
+      is?(204)
+    end
+
+    # @return [Boolean] wether the status is 400.
+    def bad_request?
+      is?(400)
+    end
+
+    # @return [Boolean] wether the status is 401.
+    def unauthorized?
+      is?(401)
+    end
+
+    # @return [Boolean] wether the status is 404.
+    def not_found?
+      is?(404)
+    end
+
+    # @return [Boolean] wether the status is 405.
+    def method_not_allowed?
+      is?(405)
+    end
+
+    private
+
+    def initial_letter
+      @initial_letter ||= status.to_s[0]
+    end
+
+    attr_accessor :status
+  end
+end

data/lib/dialers/transformable.rb

@@ -0,0 +1,84 @@
+module Dialers
+  # This class provide some ways to transform a reponse into an object or a set of objects
+  # based on what objects the user of this class wants to provide.
+  class Transformable
+    def initialize(response)
+      self.response = response
+      self.raw_data = response.body
+    end
+
+    # Transforms a response into one object based on the response's body.
+    #
+    # If you pass a hash like this:
+    #
+    #   { 200 => ProductCreated, 202 => ProductAccepted }
+    #
+    # the transformation will decide which object to create based on the status.
+    #
+    # It's important to note that the class must provide attribute writers for this method to be
+    # able to fill an object with the responses's body data.
+    #
+    # @param entity_class_or_decider [Hash, Class] A class or a hash of Fixnum => Class
+    #   to decide with the status.
+    # @param root [String, nil] The root to use to get the object from the body.
+    #
+    # @return [Object] The result of the transformation.
+    def transform_to_one(entity_class_or_decider, root: nil)
+      object = root ? raw_data[root] : raw_data
+      transform_attributes_to_object(entity_class_or_decider, object)
+    end
+
+    # Transforms a response into many objects based on the response's body.
+    #
+    # @param entity_class_or_decider [Hash, Class] A class or a hash of Fixnum => Class
+    #   to decide with the status.
+    # @param root [String, nil] The root to use to get an array from the body.
+    #
+    # @return [Array<Object>] The result of the transformation.
+    def transform_to_many(entity_class_or_decider, root: nil)
+      items = get_rooted_items(root)
+      unless items.is_a?(Array)
+        fail Dialers::ImpossibleTranformationError.new(response)
+      end
+      items.map { |item| transform_attributes_to_object(entity_class_or_decider, item) }
+    end
+
+    # Returns the raw body of the request.
+    # @return [Hash, Array] the raw body of the request.
+    def as_received
+      raw_data
+    end
+
+    private
+
+    attr_accessor :raw_data, :response
+
+    def transform_attributes_to_object(entity_class_or_decider, attributes)
+      entity_class = decide_entity_class(entity_class_or_decider)
+      if entity_class.nil?
+        fail Dialers::ResponseError.new(response)
+      else
+        Dialers::AssignAttributes.call(entity_class.new, attributes)
+      end
+    end
+
+    def decide_entity_class(entity_class_or_decider)
+      case entity_class_or_decider
+      when Class
+        entity_class_or_decider
+      when Hash
+        entity_class_or_decider[response.status]
+      end
+    end
+
+    def get_rooted_items(root)
+      if root.nil?
+        raw_data
+      elsif raw_data.is_a?(Array)
+        raw_data
+      else
+        raw_data[root]
+      end
+    end
+  end
+end

data/lib/dialers/version.rb

@@ -0,0 +1,3 @@
+module Dialers
+  VERSION = "0.1.0"
+end

data/lib/dialers/wrapper.rb

@@ -0,0 +1,34 @@
+module Dialers
+  # This class is just a convenience to this:
+  #
+  #   class Anything
+  #     def api_caller
+  #       @api_caller ||= ApiCaller.new
+  #     end
+  #   end
+  #
+  # Instead, you can wrap it like this:
+  #
+  #   class Anything < Dialers::Wrapper
+  #     api_caller { ApiCaller.new }
+  #   end
+  #
+  # The major reason of the existence of this class is to provide a place to add future
+  # improvements like automatic injection of callers within Rails based on conventions and
+  # methods and patterns that may arise in the future.
+  #
+  class Wrapper
+    # Defines the api caller instance to use on all wrappers.
+    #
+    #   api_caller { ApiCaller.new }
+    #
+    def self.api_caller(&block)
+      define_method(:api_caller) do
+        @api_caller ||= block.call
+      end
+    end
+
+    # Returns the value of the `api_caller` as defined by the {api_caller} class method
+    attr_reader :api_caller
+  end
+end

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: dialers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- juliogarciag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday-conductivity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Api Wrappers for Ruby
+email:
+- julioggonz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-vars-example
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/rspec
+- bin/setup
+- dialers.gemspec
+- examples/github/api.rb
+- examples/github/api_caller.rb
+- examples/github/usage.rb
+- examples/twitter/api.rb
+- examples/twitter/api_caller.rb
+- examples/twitter/usage.rb
+- lib/dialers.rb
+- lib/dialers/assign_attributes.rb
+- lib/dialers/caller.rb
+- lib/dialers/errors.rb
+- lib/dialers/request_options.rb
+- lib/dialers/short_circuit.rb
+- lib/dialers/short_circuits_collection.rb
+- lib/dialers/status.rb
+- lib/dialers/transformable.rb
+- lib/dialers/version.rb
+- lib/dialers/wrapper.rb
+homepage: https://github.com/platanus/dialers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Api Wrappers for Ruby
+test_files: []