fimmed_up 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f821bee7a0c16b2bcc9c1ff08aa46718639d455
+  data.tar.gz: 947bb89bfa4ff11e3f0d5119cef55f1de1e63f2f
+SHA512:
+  metadata.gz: 2f862869f944710ab4a0d6aede796bc57ecbf4526fdd419e831585f747cd4de06136829e99fac609347c5e2e674eef209ad9d6f88b96ebf834808a1673ea4247
+  data.tar.gz: f799c8d1f073ba78cc11bc37f682dcaec0e62909a5cbd7b60b4b1a0cdae529cbc35b6e21c5c4a7499c9dc13e80c09a31bed3de09a5af01ba59b241c0ede174e2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rspec
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/tmp
+spec/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jovon Packard
+
+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,29 @@
+# FimmedUp
+
+Restful API Client for the Fimmed_up API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fimmed_up'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fimmed_up
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/fimmed_up.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fimmed_up/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fimmed_up"
+  spec.version       = FimmedUp::VERSION
+  spec.authors       = ["Jovon Packard"]
+  spec.email         = ["jovonpackard@gmail.com"]
+  spec.description   = %q{Client gem to connect to the fimmed_up API}
+  spec.summary       = %q{Client for fimmed_up API}
+  spec.homepage      = ""
+  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_dependency 'faraday'
+  spec.add_dependency 'json'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"  
+  spec.add_development_dependency "pry-remote"
+end

data/lib/fimmed_up/client.rb

@@ -0,0 +1,35 @@
+require 'fimmed_up/connection'
+require 'fimmed_up/parameters'
+require 'fimmed_up/helpers'
+
+module FimmedUp
+ 
+  class Client
+    include FimmedUp::Connection    
+    include FimmedUp::Parameters
+
+    # Define the same set of accessors as the FimmedUp module
+    attr_accessor *Configuration::VALID_CONFIG_KEYS    
+ 
+    def initialize(options={})
+      # Merge the config values from the module and those passed
+      # to the client.
+      merged_options = FimmedUp.options.merge(options)      
+      # Copy the merged values to this client and ignore those
+      # not part of our configuration
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def updated
+      self.get("#{resource}/updatedtoday/count", parameters, {}).to_i      
+    end
+
+    def count      
+      self.get("#{resource}/count", parameters, {}).to_i      
+    end    
+      
+  end # Client
+ 
+end

data/lib/fimmed_up/configuration.rb

@@ -0,0 +1,38 @@
+module FimmedUp
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :method].freeze
+    VALID_OPTIONS_KEYS    = [:username, :password, :resource].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+
+    DEFAULT_METHOD      = :get    
+    DEFAULT_ENDPOINT    =  'http://10.0.0.140'
+    DEFAULT_USERNAME    = ENV["API_USERNAME"].to_s
+    DEFAULT_PASSWORD    = ENV["API_PASSWORD"].to_s
+    DEFAULT_RESOURCE    = "profile"
+
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+        
+    def reset
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.method     = DEFAULT_METHOD      
+      self.username   = DEFAULT_USERNAME
+      self.password   = DEFAULT_PASSWORD
+      self.resource   = DEFAULT_RESOURCE
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end
+end

data/lib/fimmed_up/connection.rb

@@ -0,0 +1,35 @@
+require 'faraday'
+require 'fimmed_up/response/raise_client_error'
+require 'fimmed_up/response/raise_server_error'
+
+module FimmedUp
+  module Connection
+
+    private
+
+    def connection(options)
+      default_options = {
+        :url => options.fetch(:endpoint, endpoint),
+        :user => options.fetch(:username, username),
+        :password => options.fetch(:password, password)        
+
+      }
+
+      @connection ||= Faraday.new(default_options) do |builder|
+        builder.use FimmedUp::Response::RaiseClientError
+        builder.use FimmedUp::Response::RaiseServerError
+
+        builder.basic_auth(default_options[:user], default_options[:password])
+        builder.headers["Http-Accept"] = "application/json"
+        builder.headers["Content-Type"] = "application/json"
+        
+        # TODO: Make logging optional
+        # builder.response :logger
+
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+  end # Connection
+
+end

data/lib/fimmed_up/error.rb

@@ -0,0 +1,20 @@
+module FimmedUp
+
+  class Error < StandardError
+    attr_reader :http_headers
+
+    def initialize(message, http_headers)
+      @http_headers = http_headers
+      super(message)
+    end
+
+  end # Error
+
+  class Error::ServerError        < FimmedUp::Error; end
+  class Error::ServiceUnavailable < Error::ServerError; end
+
+  class Error::ClientError     < FimmedUp::Error; end
+  class Error::Forbidden       < Error::ClientError; end
+  class Error::BadRequest      < Error::ClientError; end
+  class Error::RequestTooLarge < Error::ClientError; end
+end

data/lib/fimmed_up/helpers.rb

@@ -0,0 +1,9 @@
+require 'json'
+
+module FimmedUp
+  module Helpers
+    def json(response)
+      @json ||= JSON.parse(response) if response
+    end
+  end
+end

data/lib/fimmed_up/parameters.rb

@@ -0,0 +1,53 @@
+require 'fimmed_up/request'
+require 'fimmed_up/helpers'
+
+module FimmedUp
+  module Parameters
+    include Enumerable
+    include FimmedUp::Request
+    include FimmedUp::Helpers
+
+    def parameters
+      @parameters ||= {}
+    end
+
+    def where(args)
+      parameters.merge!(args)
+      self
+    end
+
+    def like(args)      
+      parameters.merge!(like_format(args))      
+      self
+    end
+    
+    def limit(limit)
+      parameters[:limit] = limit
+      self
+    end
+
+    def select(args)
+      parameters[:fields] = args
+      self
+    end
+
+    def find(id)
+      parameters.merge!(id: id)
+      self   
+    end  
+
+    def each(&block)
+      records = self.get(resource, parameters, {})
+      raise "Records not found" if records.empty?
+      json(records).each(&block)
+    end
+
+    private
+      def like_format(args)       
+        return_args = args.map do | key, value |          
+          hash = { "#{key.to_s}.like" => "%#{value}%" }          
+        end        
+        return_args[0]
+      end
+  end
+end

data/lib/fimmed_up/request.rb

@@ -0,0 +1,50 @@
+require 'net/http'
+require 'uri'
+require 'pry'
+
+module FimmedUp
+  # Handless HTTP requests
+  module Request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    def post(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+    def delete(path, params={}, options={})
+      request(:delete, path, params, options)
+    end
+
+    def patch(path, params={}, options={})
+      request(:patch, path, params, options)
+    end
+
+    private
+
+    def request(method, path, params, options)
+
+      response = connection(options).run_request(method, nil, nil, nil) do |request|
+        request.options[:raw] = true if options[:raw]
+
+        case method.to_sym
+        when :get          
+          request.url(path, params)
+        when :post
+          request.path = path
+          request.body = params unless params.empty?
+        when :delete
+          request.path = path
+          request.body = params unless params.empty?          
+        when :patch
+          request.path = path
+          request.body = params unless params.empty?
+        end
+      end      
+      options[:raw] ? response : response.body
+    end
+
+  end # Request
+
+end

data/lib/fimmed_up/response/raise_client_error.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module FimmedUp
+
+  module Response
+
+    class RaiseClientError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        status  = env[:status].to_i
+        body    = env[:body]
+        headers = env[:response_headers]
+
+        case status
+        when 400
+          raise FimmedUp::Error::BadRequest.new body, headers
+        when 403
+          raise FimmedUp::Error::Forbidden.new body, headers
+        when 413
+          raise FimmedUp::Error::RequestTooLarge.new body, headers
+        end
+      end
+
+    end # RaiseClientError
+
+  end # Response
+
+end

data/lib/fimmed_up/response/raise_server_error.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'fimmed_up/error'
+
+module FimmedUp
+  module Response
+    class RaiseServerError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        status  = env[:status].to_i
+        body    = env[:body]
+        headers = env[:response_headers]
+
+        case status
+        when 503
+          raise FimmedUp::Error::ServiceUnavailable.new "503 No server is available to handle this request.", headers
+        end
+      end
+
+    end # RaiseServerError
+
+  end # Response
+
+end

data/lib/fimmed_up/version.rb

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

data/lib/fimmed_up.rb

@@ -0,0 +1,26 @@
+require "fimmed_up/version"
+require "fimmed_up/configuration"
+require "fimmed_up/client"
+require "fimmed_up/parameters"
+require "fimmed_up/helpers"
+
+module FimmedUp
+  extend Configuration
+  include FimmedUp::Helpers   
+
+  def new(options={})
+    Client.new(options)
+  end
+
+  # Delegate to FimmedUp::Client
+
+  def method_missing(method, *args, &block)
+    return super unless new.respond_to?(method)
+    new.send(method, *args, &block)
+  end
+
+  def respond_to?(method, include_private = false)
+    new.respond_to?(method, include_private) || super(method, include_private)
+  end
+
+end

data/spec/fimmed_up/client_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe FimmedUp::Client do
+
+  before do
+    @keys = FimmedUp::Configuration::VALID_CONFIG_KEYS
+  end
+
+  describe 'with module configuration' do
+    before do
+      FimmedUp.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      FimmedUp.reset
+    end
+
+    it "should inherit module configuration" do
+      api = FimmedUp::Client.new
+      @keys.each do |key|
+        api.send(key).eql? key
+      end
+    end
+
+    describe 'with class configuration' do
+      before do
+        @config = {
+          :endpoint   => 'ep',
+          :method     => 'hm',
+          :username   => 'ej',
+          :password   => 'uo'
+        }
+      end
+
+      it 'should override module configuration' do
+        api = FimmedUp::Client.new(@config)
+        @keys.each do |key|
+          api.send(key).eql? @config[key]
+        end
+      end
+
+      it 'should override module configuration after' do
+        api = FimmedUp::Client.new
+
+        @config.each do |key, value|
+          api.send("#{key}=", value)
+        end
+
+        @keys.each do |key|
+          api.send("#{key}").eql? @config[key]
+        end
+      end
+
+    end
+
+  end
+
+  describe 'access to api'do    
+    context 'when logged in' do
+      it 'should not be blank' do
+        client = FimmedUp::Client.new(resource: "profile")
+        profile = client.find(5)
+        expect(profile.first["id"]).to eq("5".rjust(6))
+      end
+    end    
+  end
+
+  describe '.where' do
+    before do
+      @profiles = FimmedUp::Client.new(resource: "profile")
+    end
+    it 'should return the correct records' do
+      profile = []
+      @profiles.where(orgname: "Active Heroes").each { |u| profile << u }      
+      profile.each { |r| expect(r["orgname"]).to eq("Active Heroes") }
+    end
+  end
+
+  describe '.find' do
+    before do
+      @profiles = FimmedUp::Client.new(resource: "profile")
+    end
+    it 'should return id' do      
+      profile = @profiles.find(5)      
+      expect(profile.first["id"]).to eq('5'.rjust(6))
+    end
+  end
+  
+  describe '.like' do
+    before do
+      @profiles = FimmedUp::Client.new(resource: "profile")      
+    end    
+    it 'returns orgname like' do
+      profile = []        
+      @profiles.like(orgname: "Active").each { 
+        |u| profile << u 
+      }        
+      expect(profile.first["orgname"].downcase).to include("active")
+    end    
+  end
+
+  describe '.limit' do
+    before do
+      @profiles = FimmedUp::Client.new(resource: "profile")
+    end
+    it 'should return the correct records' do
+      profile = []
+      @profiles.limit(20).each { |u| profile << u }      
+      expect(profile.count).to eq(20)
+    end
+  end
+
+  describe '.updated' do
+    before do
+      @profiles = FimmedUp::Client.new(resource: "profile")
+    end
+    it 'should return the number of records updated today' do      
+      updated = @profiles.updated
+      expect(updated).to eq(0)
+    end
+  end
+
+  describe '.count' do
+    before do
+      @profiles = FimmedUp::Client.new(resource: "profile")
+    end
+    it 'should return the number of records' do      
+      count = @profiles.count      
+      expect(count).to eq(37397)
+    end
+  end
+
+  describe '.select' do
+    before do
+      @profiles = FimmedUp::Client.new(resource: "profile")      
+    end
+    it 'returns only fields' do
+      profile = []
+      @profiles.where(orgname: "Active Heroes").select(['id', 'orgname']).each { |u| profile << u }
+      expect(profile.first.keys).to include('id', 'orgname')
+      expect(profile.first.count).to eq(2)
+    end
+  end    
+  
+
+end

data/spec/fimmed_up/configuration_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe FimmedUp::Configuration do
+  after do
+    FimmedUp.reset
+  end
+
+  describe '.username' do
+    it 'should have correct username' do
+      FimmedUp.username.eql? FimmedUp::Configuration::DEFAULT_USERNAME
+    end
+  end
+
+  describe '.password' do
+    it 'should have correct password' do
+      FimmedUp.password.eql? FimmedUp::Configuration::DEFAULT_PASSWORD
+    end
+  end
+
+  describe '.endpoint' do
+    it 'should return the default endpoint' do
+      FimmedUp.endpoint.eql? FimmedUp::Configuration::DEFAULT_ENDPOINT
+    end
+  end
+
+  FimmedUp::Configuration::VALID_CONFIG_KEYS.each do |key|
+    describe ".#{key}" do
+      it 'should return the default value' do
+        FimmedUp.send(key).eql? FimmedUp::Configuration.const_get("DEFAULT_#{key.upcase}")
+      end
+    end
+  end
+end

data/spec/fimmed_up/fimmed_up_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe FimmedUp do
+  it 'should have a version' do
+    FimmedUp::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "fimmed_up"
+require "rspec"
+require "json"
+require "pry-remote"
+
+Dir["./spec/support/*.rb"].sort.each {|file| require file}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus 
+  config.include JsonHelpers
+end

data/spec/support/json_helpers.rb

@@ -0,0 +1,5 @@
+module JsonHelpers
+  def json(response)
+    @json ||= JSON.parse(response) if response
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: fimmed_up
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jovon Packard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client gem to connect to the fimmed_up API
+email:
+- jovonpackard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fimmed_up.gemspec
+- lib/fimmed_up.rb
+- lib/fimmed_up/client.rb
+- lib/fimmed_up/configuration.rb
+- lib/fimmed_up/connection.rb
+- lib/fimmed_up/error.rb
+- lib/fimmed_up/helpers.rb
+- lib/fimmed_up/parameters.rb
+- lib/fimmed_up/request.rb
+- lib/fimmed_up/response/raise_client_error.rb
+- lib/fimmed_up/response/raise_server_error.rb
+- lib/fimmed_up/version.rb
+- spec/fimmed_up/client_spec.rb
+- spec/fimmed_up/configuration_spec.rb
+- spec/fimmed_up/fimmed_up_spec.rb
+- spec/fimmed_up/request_spec.rb
+- spec/spec_helper.rb
+- spec/support/json_helpers.rb
+homepage: ''
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Client for fimmed_up API
+test_files:
+- spec/fimmed_up/client_spec.rb
+- spec/fimmed_up/configuration_spec.rb
+- spec/fimmed_up/fimmed_up_spec.rb
+- spec/fimmed_up/request_spec.rb
+- spec/spec_helper.rb
+- spec/support/json_helpers.rb