served 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29a2b56443a1a80b781afd1a6748db0d0c36164b
+  data.tar.gz: 9d12321a5ed7b46bc639dcf8791e2f236beb26a3
+SHA512:
+  metadata.gz: e51558cc1fe9f0b87b7c0141f2a107c3e823f3a1838d8177518ad6433232f5967781c16ba5c9048a0f160ad07a9167b4817f1a79d0aabd4fbfd15581762cc910
+  data.tar.gz: 748a36574dfdcbb27f39a3cb948e2fd237562945254367265b1509032cd8690f4d7f4d8e8eff3ac9d6023b8eac7f0b5d76578b26b59e61f5b9db0c90561c3978

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml
+.idea/**

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jarod Reid
+
+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,60 @@
+# Served
+[![Build Status](https://travis-ci.org/fugufish/served.svg)](https://travis-ci.org/fugufish/served)
+
+Served is a gem in the vein of [ActiveResource](https://github.com/rails/activeresource) designed to facilitate
+communication between distributed Rails services.
+
+# Installation
+
+Add the following to your Gemfile:
+
+```gem 'served'```
+
+# Usage
+
+```ruby
+class SomeService::SomeResource < Served::Resource::Base
+
+   attribute :name
+   attribute :date
+   attribute :phone_number
+
+end
+```
+
+# Configuration
+
+Served is configured using ```Served.config```.
+
+## Configuration Options
+
+### Hosts (required)
+
+Served uses the adjacent namespace of the resource to determine the the url for that service. For example given this
+configuration:
+
+```ruby
+Served.configure do |c|
+  c.hosts = {
+    some_service:       'http://localhost:3000',
+    some_other_service: 'http://localhost:3001'
+  }
+```
+
+and given this resource
+
+```ruby
+class SomeService::SomeResource < Served::Resource::Base
+
+   attribute :name
+   attribute :date
+   attribute :phone_number
+
+end
+```
+
+```SomeService::SomeResource``` would map back to http://localhost:3000/some_resources.
+
+### Timeout
+
+Sets the request time out.

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 "served"
+
+# 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

data/bin/setup

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

data/lib/served.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+require 'active_support/configurable'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/module'
+
+require 'served/engine'
+require 'served/version'
+require 'served/http_client'
+require 'served/resource'
+
+module Served
+  include ActiveSupport::Configurable
+  configure do |config|
+    config.timeout = 30
+  end
+end

data/lib/served/engine.rb

@@ -0,0 +1,6 @@
+if Object.const_defined?(:Rails)
+  module Served
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/served/http_client.rb

@@ -0,0 +1,38 @@
+module Served
+  # Provides an interface between HTTParty and the models. Most of the crap in here is self explanatory
+  class HTTPClient
+    HEADERS = { 'Content-type' => 'application/json', 'Accept' => 'application/json' }
+
+    def initialize(host)
+      @host = host
+    end
+
+    def get(endpoint, params={})
+      HTTParty.get("#{@host}/#{endpoint}",
+                   query: params,
+                   headers: HEADERS,
+                   timeout: Served.config.timeout
+      )
+    end
+
+    def put(endpoint, body, params={})
+      HTTParty.put(
+        "#{@host}/#{endpoint}",
+        body:    body,
+        query:   params,
+        headers: HEADERS,
+        timeout: Served.config.timeout
+      )
+    end
+
+    def post(endpoint, body, params={})
+      HTTParty.post(
+        "#{@host}/#{endpoint}",
+        body:    body,
+        query:   params,
+        headers: HEADERS,
+        timeout: Served.config.timeout
+      )
+    end
+  end
+end

data/lib/served/resource.rb

@@ -0,0 +1 @@
+require 'served/resource/base'

data/lib/served/resource/base.rb

@@ -0,0 +1,157 @@
+module Served
+  module Resource
+    # Service Resources should inherit directly from this class. Provides interfaces necessary for communicating with
+    # services based on the namespace. Classes should be namespaced under Services::ServiceName where ServiceName is the
+    # name of the service the resource lives on. The resource determines the host of the service based on this
+    # this namespace and what is in the configuration.
+    class Base
+      # raised when an attribute is passed to a resource that is not declared
+      class InvalidAttributeError < StandardError; end
+
+      # raised when the connection receives a response from a service that does not constitute a 200
+      class ServiceError < StandardError
+        def initialize(response)
+          @code = response.code
+          super "An error occurred making the request: #{@code}"
+        end
+      end
+
+      class << self
+        # declare an attribute for the resource
+        #
+        # @example
+        #   class SomeResource
+        #     attribute :attr1
+        #   end
+        def attribute(name)
+          return if attributes.include?(name)
+          attributes << name
+          attr_accessor name
+        end
+
+        # @return [Array] declared attributes for the resources
+        def attributes
+          @attributes ||= []
+        end
+
+        # Looks up a resource on the service by id. For example `SomeResource.find(5)` would call `/some_resources/5`
+        def find(id)
+          instance = new(id: id)
+          instance.reload
+        end
+
+        # @return [String] the name of the resource. `SomeResource.resource_name` will return `some_resources`
+        def resource_name
+          name.split('::').last.tableize
+        end
+
+        # @return [String] the configured host.
+        # @see Services::Configuration
+        def host
+          Served.config[:hosts][parent.name.underscore.split('/')[-1]]
+        end
+
+        # @return [Served::HTTPClient] The connection instance to the service host. Note this is not an active
+        # connection but a passive one.
+        def client
+          @connection ||= Served::HTTPClient.new(host)
+        end
+
+        private
+
+        # Everything should allow an id attribute
+        def inherited(subclass)
+          return if subclass.attributes.include?(:id) # attribute method does this already, but rather not do a
+          # class_eval if not necessary
+          subclass.class_eval do
+            attribute :id
+          end
+        end
+      end
+
+      # Instantiates a resource with the given attributes.
+      #
+      # @raise [InvalidAttributeError] in the case that an attribute is passed that is not declared
+      def initialize(attributes={})
+        reload_with_attributes(attributes)
+      end
+
+      # @see Services::Resource::Base::resource_name
+      def resource_name
+        self.class.resource_name
+      end
+
+      # Saves the record to the service. Will call POST if the record does not have an id, otherwise will call PUT
+      # to update the record
+      def save
+        if id
+          reload_with_attributes(put[resource_name.singularize])
+        else
+          reload_with_attributes(post[resource_name.singularize])
+        end
+        true
+      end
+
+      alias_method :save!, :save # TODO: differentiate save! and safe much the same AR does.
+
+      # Returns a hash of attributes. If `with_values` is true, it will return only attributes whose values are not nil
+      #
+      # @param [Boolean] with_values whether or not to return all attributes or only those whose values are not nil
+      def attributes
+        Hash[self.class.attributes.collect { |name| [name, send(name)] }]
+      end
+
+      # Reloads the resource using attributes from the service
+      def reload
+        reload_with_attributes(get)
+      end
+
+      # renders the model as json
+      def to_json
+        raise InvalidPresenter, 'Presenter must respond to #to_json' unless presenter.respond_to? :to_json
+        presenter.to_json
+      end
+
+      # override this to return a presenter to be used for serialization, otherwise all attributes will be
+      # serialized
+      def presenter
+        { resource_name.singularize => attributes }
+      end
+
+      private
+
+      def get(params={})
+        handle_response(client.get("/#{resource_name}/#{id}.json", params))
+      end
+
+      def put(params={})
+        body = to_json
+        handle_response(client.put("/#{resource_name}/#{id}.json", body, params))
+      end
+
+      def post(params={})
+        body = to_json
+        handle_response(client.post("/#{resource_name}.json", body, params))
+      end
+
+      def handle_response(response)
+        raise ServiceError, response unless (200..299).include?(response.code)
+        JSON.parse(response.body)
+      end
+
+
+      def reload_with_attributes(attributes)
+        attributes.each { |name, value| set_attribute(name.to_sym, value) }
+      end
+
+      def set_attribute(name, value)
+        raise InvalidAttributeError, "`#{name}' is not a valid attribute" unless self.class.attributes.include?(name)
+        instance_variable_set("@#{name}", value)
+      end
+
+      def client
+        self.class.client
+      end
+    end
+  end
+end

data/lib/served/version.rb

@@ -0,0 +1,3 @@
+module Served
+  VERSION = '0.1.5'
+end

data/served.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'served/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'served'
+  spec.version       = Served::VERSION
+  spec.authors       = ['Jarod Reid']
+  spec.email         = ['jarod@solidalchemy.com']
+
+  spec.summary       = %q{Served provides an easy to use model layer for communicating with disributed Rails based Services.}
+  spec.description   = %q{Served provides an easy to use model layer for communicating with disributed Rails based Services.}
+  spec.homepage      = 'http://github.com/fugufish/served'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'activesupport', '>= 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: served
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Jarod Reid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Served provides an easy to use model layer for communicating with disributed
+  Rails based Services.
+email:
+- jarod@solidalchemy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/served.rb
+- lib/served/engine.rb
+- lib/served/http_client.rb
+- lib/served/resource.rb
+- lib/served/resource/base.rb
+- lib/served/version.rb
+- served.gemspec
+homepage: http://github.com/fugufish/served
+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.8
+signing_key: 
+specification_version: 4
+summary: Served provides an easy to use model layer for communicating with disributed
+  Rails based Services.
+test_files: []
+has_rdoc: