ezapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9f560c99144dec1335c0fff65c18ab7b8d2e45a
+  data.tar.gz: 4a745539e16f2d9f0ca262debc00422474204029
+SHA512:
+  metadata.gz: 1d08ba48dc7f31f0b568e0bbb0dab02e1491fe02d07c0052b0b928b69d2b6dd7bf94eddf022d6c5f4702f428ce557fbc24cd03149fbc3d560a27d1ca4509f6b2
+  data.tar.gz: 1afd0a7847788a23b57ec3d9744b983d39370069ed0a81270fb870118387a9d7d7323005e9a2de1ff22a6cd81d5788cb10bf7fb8149fda3af92db3f7082554f6

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem
+*.rbc
+
+# Ignore bundler config
+/.bundle
+Gemfile.lock
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ezapi.gemspec
+gemspec

data/README.md

@@ -0,0 +1,96 @@
+# EZApi
+
+EZApi makes interfacing with third party APIs easy! EZApi handles network requests, responses, and serializes the object into an easy to use ruby object. Standard RESTful actions are included out of the box  and you can easily add custom actions.
+
+## Usage
+
+Install the gem
+```ruby
+gem 'ezapi'
+```
+
+Define your API client & models
+```ruby
+module ThirdPartyApp
+  extend EZApi::Client
+
+  api_url 'http://www.example.com/api/' # => / at the end is required
+  api_key 'XXXXXX' # => required
+
+
+  class User < EZApi::ObjectBase
+    path 'foo' # => to create custom path. Defaults to 'users' in this case
+    actions [:show, :create, :delete, :update, :index] # => Included RESTful actions
+  end
+end
+```
+
+Now we can call `http://www.example.com/api/users` endpoints
+```ruby
+begin
+  user = ThirdPartyApp::User.show('123')
+  user.first_name # => returns first_name json field
+  user.first_name = 'new name'
+  user.save
+
+  ThirdPartyApp::User.delete('123')
+  ThirdPartyApp::User.update({first_name: 'Name'})
+  ThirdPartyApp::User.index({page: 1})
+rescue EZApiError => e
+  print(e.message)
+end
+```
+
+
+### Custom actions
+
+There are two ways of adding custom actions that are not in the included rest
+```ruby
+module ThirdPartyApp
+  class User < EZApi::ObjectBase
+
+    # For class methods
+    module ClassMethods
+        def custom_action
+          response = client.get("#{api_path}/custom_action")
+          # Do whatever you want with the response
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def custom_instance_action
+        response = self.class.client.get("#{self.class.api_path}/custom_action")
+        # Do whatever you want with the response
+      end
+  end
+end
+
+
+ThirdPartyApp::User.custom_action
+ThirdPartyApp::User.new.custom_instance_action
+```
+
+
+#### Add custom actions to actions array
+```ruby
+module ThirdPartyApp
+  module Actions
+    module MyCustomAction
+      def my_custom_action
+        # Do Something
+      end
+    end
+  end
+end
+
+module ThirdPartyApp
+  class User < EZApi::ObjectBase
+    actions [:my_custom_action]
+  end
+end
+
+```
+You can even override the include REST actions using this method

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ezapi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ezapi.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ezapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ezapi"
+  spec.version       = EZApi::VERSION
+  spec.authors       = ["Nicholas"]
+
+  spec.summary       = "Easily Communicate with APIs"
+  spec.description   = "Wrapper around interacting with APIs"
+  spec.homepage      = "https://github.com/nbwar/ezapi"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+end

data/lib/ezapi/actions/create.rb

@@ -0,0 +1,17 @@
+module EZApi
+  module Actions
+    module Create
+      module ClassMethods
+        def create(params = {})
+          obj = new(params)
+          obj.save
+          obj
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/ezapi/actions/delete.rb

@@ -0,0 +1,23 @@
+module EZApi
+  module Actions
+    module Delete
+      module ClassMethods
+        def delete(id)
+          response = client.delete("#{api_path}/#{id}")
+          true
+        end
+      end
+
+      def delete
+        if id
+          self.class.client.delete("#{self.class.api_path}/#{id}")
+          true
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/ezapi/actions/index.rb

@@ -0,0 +1,27 @@
+module EZApi
+  module Actions
+    module Index
+      module ClassMethods
+        def index(query_params, params = {})
+          response = client.get(list_path(query_params), params)
+          response.compact.map { |item| self.new(item) }
+        end
+
+        private
+          def list_path(query_params)
+            [api_path, build_query_params(query_params)].compact.join('?')
+          end
+
+          def build_query_params(query_params)
+            query_params && query_params
+              .collect { |key, value| "#{key}=#{URI.encode_www_form_component(value)}" }
+              .join('&')
+          end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/ezapi/actions/save.rb

@@ -0,0 +1,21 @@
+module EZApi
+  module Actions
+    module Save
+      def save
+        response = self.class.client.send(request_type, save_path, as_json)
+        assign_attributes(response) if response
+        true
+      end
+
+      private
+
+      def request_type
+        id ? :put : :post
+      end
+
+      def save_path
+        [self.class.api_path, id].compact.join('/')
+      end
+    end
+  end
+end

data/lib/ezapi/actions/show.rb

@@ -0,0 +1,16 @@
+module EZApi
+  module Actions
+    module Show
+      module ClassMethods
+        def show(id)
+          response = client.get("#{api_path}/#{id}")
+          self.new(response)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/ezapi/actions/update.rb

@@ -0,0 +1,15 @@
+module EZApi
+  module Actions
+    module Update
+      module ClassMethods
+        def update(id, params)
+          new(params.merge(id: id)).save
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/ezapi/client.rb

@@ -0,0 +1,92 @@
+require 'rest-client'
+require 'json'
+require 'base64'
+require 'uri'
+
+module EZApi
+  module Client
+    attr_accessor :key, :base_url
+
+    def self.extended(base)
+      [:get, :post, :put, :patch, :delete].each do |method|
+        define_method(method) do |path, params = {}|
+          full_path = full_api_path(path)
+          request(full_path, :put, params)
+        end
+      end
+    end
+
+    def api_url(url)
+      self.base_url = url
+    end
+
+    def api_key(key)
+      self.key = key
+    end
+
+    def request(full_url, method, params={})
+      raise(AuthenticationError, "API key is not set for #{self.app_name}.") unless self.key
+
+      begin
+        response = RestClient::Request.execute(method: method, url: full_url, payload: params.to_json, headers: request_headers)
+        JSON.parse(response) unless response.empty?
+      rescue RestClient::ExceptionWithResponse => e
+        if response_code = e.http_code and response_body = e.http_body
+          handle_api_error(response_code, JSON.parse(response_body))
+        else
+          handle_restclient_error(e)
+        end
+      rescue RestClient::Exception, Errno::ECONNREFUSED => e
+        handle_restclient_error(e)
+      end
+    end
+
+    protected
+      def app_name
+        self.name.demodulize
+      end
+
+      def full_api_path(path)
+        URI.join(base_url, path).to_s
+      end
+
+      def request_headers
+        {
+          Authorization: "Basic #{encoded_api_key}",
+          content_type: :json,
+          accept: :json
+        }
+      end
+
+      def encoded_api_key
+        Base64.urlsafe_encode64(self.key)
+      end
+
+      def parse_error_message(body)
+        body['message']
+      end
+
+      def handle_api_error(code, body)
+        message = parse_error_message(body)
+        case code
+        when 400, 404
+          raise(InvalidRequestError, message)
+        when 401
+          raise(AuthenticationError, message)
+        else
+          raise(ApiError, message)
+        end
+      end
+
+      def handle_restclient_error(e)
+        case e
+        when RestClient::ServerBrokeConnection
+          message = "The connection with #{app_name} terminated before the request completed."
+        else
+          message = "Could not connect to #{app_name}."
+        end
+
+        raise(ConnectionError, message)
+      end
+  end
+end

data/lib/ezapi/dsl.rb

@@ -0,0 +1,43 @@
+module EZApi
+  module DSL
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def path(url)
+        define_singleton_method(:api_path) { url }
+      end
+
+      def actions(actions)
+        actions.each do |action|
+          include_action(action)
+        end
+
+        if (actions & [:create, :update]).any? && !actions.include?(:save)
+          include_action(:save)
+        end
+      end
+
+      def client
+        client_name = self.name.deconstantize
+        @client ||= !client_name.empty? ? client_name.constantize : EZApi::Client
+      end
+
+      def api_path
+        path = self.name.demodulize.underscore.pluralize
+        "#{CGI.escape(path)}"
+      end
+
+      private
+        def include_action(action)
+          begin
+            include client::Actions.const_get(action.to_s.camelize)
+          rescue NameError
+            include EZApi::Actions.const_get(action.to_s.camelize)
+          end
+        end
+    end
+
+  end
+end

data/lib/ezapi/errors.rb

@@ -0,0 +1,7 @@
+module EZApi
+  class EZApiError < StandardError;end
+  class AuthenticationError < EZApiError; end
+  class InvalidRequestError < EZApiError; end
+  class ConnectionError < EZApiError; end
+  class ApiError < EZApiError; end
+end

data/lib/ezapi/object_base.rb

@@ -0,0 +1,53 @@
+module EZApi
+  class ObjectBase
+    include EZApi::DSL
+
+    attr_reader :params
+
+    def initialize(params={})
+      assign_attributes(params)
+    end
+
+    def id
+      attributes['id']
+    end
+
+     def id=(value)
+      attributes['id'] = value
+    end
+
+    def as_json(*options)
+      attributes.as_json(*options)
+    end
+
+    private
+      def assign_attributes(params)
+        params.each do |key, value|
+          key = key.to_s.underscore
+          define_attribute_accessors(key) unless respond_to?(key)
+
+          # TODO: Support creating real api objects based on associations
+          case value
+          when Array
+            value = value.map do |obj|
+              obj.is_a?(Hash) ? ObjectBase.new(obj) : obj
+            end
+          when Hash
+            value = ObjectBase.new(value)
+          end
+
+          public_send(:"#{key}=", value)
+        end
+      end
+
+      def define_attribute_accessors(attr)
+        attr = attr.to_s
+        define_singleton_method(:"#{attr}=") { |value| attributes[attr] = value }
+        define_singleton_method(attr) { attributes[attr] }
+      end
+
+      def attributes
+        @attributes ||= {}
+      end
+  end
+end

data/lib/ezapi/version.rb

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

data/lib/ezapi.rb

@@ -0,0 +1,22 @@
+# Dependencies
+require 'active_support/core_ext/string/inflections'
+require 'active_support/json'
+require 'active_support/core_ext/object/json'
+
+# Main
+require "ezapi/version"
+require "ezapi/errors"
+require "ezapi/client"
+require "ezapi/dsl"
+require "ezapi/object_base"
+
+# Actions
+require "ezapi/actions/show"
+require "ezapi/actions/save"
+require "ezapi/actions/create"
+require "ezapi/actions/delete"
+require "ezapi/actions/update"
+require "ezapi/actions/index"
+
+module EZApi
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ezapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: Wrapper around interacting with APIs
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ezapi.gemspec
+- lib/ezapi.rb
+- lib/ezapi/actions/create.rb
+- lib/ezapi/actions/delete.rb
+- lib/ezapi/actions/index.rb
+- lib/ezapi/actions/save.rb
+- lib/ezapi/actions/show.rb
+- lib/ezapi/actions/update.rb
+- lib/ezapi/client.rb
+- lib/ezapi/dsl.rb
+- lib/ezapi/errors.rb
+- lib/ezapi/object_base.rb
+- lib/ezapi/version.rb
+homepage: https://github.com/nbwar/ezapi
+licenses: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Easily Communicate with APIs
+test_files: []