restorm 1.0.0

data/lib/restorm/model/relation.rb

@@ -0,0 +1,209 @@
+module Restorm
+  module Model
+    class Relation
+
+      # @private
+      attr_accessor :params
+      attr_writer :parent
+
+      # @private
+      def initialize(parent)
+        @parent = parent
+        @params = {}
+      end
+
+      # @private
+      def apply_to(attributes)
+        @params.merge(attributes)
+      end
+
+      # Build a new resource
+      def build(attributes = {})
+        @parent.build(@params.merge(attributes))
+      end
+
+      # Add a query string parameter
+      #
+      # @example
+      #   @users = User.all
+      #   # Fetched via GET "/users"
+      #
+      # @example
+      #   @users = User.where(:approved => 1).all
+      #   # Fetched via GET "/users?approved=1"
+      def where(params = {})
+        return self if params.blank? && !@_fetch.nil?
+        clone.tap do |r|
+          r.params = r.params.merge(params)
+          r.clear_fetch_cache!
+        end
+      end
+      alias all where
+
+      # Bubble all methods to the fetched collection
+      #
+      # @private
+      def method_missing(method, *args, &blk)
+        fetch.send(method, *args, &blk)
+      end
+
+      # @private
+      def respond_to?(method, *args)
+        super || fetch.respond_to?(method, *args)
+      end
+
+      # @private
+      def nil?
+        fetch.nil?
+      end
+
+      # @private
+      def kind_of?(thing)
+        fetch.is_a?(thing)
+      end
+
+      # Fetch a collection of resources
+      #
+      # @private
+      def fetch
+        @_fetch ||= begin
+          path = @parent.build_request_path(@parent.collection_path, @params)
+          method = @parent.method_for(:find)
+          @parent.request(@params.merge(:_method => method, :_path => path)) do |parsed_data, _|
+            @parent.new_collection(parsed_data)
+          end
+        end
+      end
+
+      # Fetch specific resource(s) by their ID
+      #
+      # @example
+      #   @user = User.find(1)
+      #   # Fetched via GET "/users/1"
+      #
+      # @example
+      #   @users = User.find([1, 2])
+      #   # Fetched via GET "/users/1" and GET "/users/2"
+      def find(*ids)
+        params = @params.merge(ids.last.is_a?(Hash) ? ids.pop : {})
+        ids = Array(params[@parent.primary_key]) if params.key?(@parent.primary_key)
+
+        results = ids.flatten.compact.uniq.map do |id|
+          resource = nil
+          request_params = params.merge(
+            :_method => @parent.method_for(:find),
+            :_path => @parent.build_request_path(params.merge(@parent.primary_key => id))
+          )
+
+          @parent.request(request_params) do |parsed_data, response|
+            if response.success?
+              resource = @parent.new_from_parsed_data(parsed_data)
+              resource.run_callbacks :find
+            else
+              return nil
+            end
+          end
+
+          resource
+        end
+
+        ids.length > 1 || ids.first.is_a?(Array) ? results : results.first
+      end
+
+      # Fetch first resource with the given attributes.
+      #
+      # If no resource is found, returns <tt>nil</tt>.
+      #
+      # @example
+      #   @user = User.find_by(name: "Tobias", age: 42)
+      #   # Called via GET "/users?name=Tobias&age=42"
+      def find_by(params)
+        where(params).first
+      end
+
+      # Fetch first resource with the given attributes, or create a resource
+      # with the attributes if one is not found.
+      #
+      # @example
+      #   @user = User.find_or_create_by(email: "remi@example.com")
+      #
+      #   # Returns the first item in the collection if present:
+      #   # Called via GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   # POST /users with `email=remi@example.com`
+      #   @user.email # => "remi@example.com"
+      #   @user.new? # => false
+      def find_or_create_by(attributes)
+        find_by(attributes) || create(attributes)
+      end
+
+      # Fetch first resource with the given attributes, or initialize a resource
+      # with the attributes if one is not found.
+      #
+      # @example
+      #   @user = User.find_or_initialize_by(email: "remi@example.com")
+      #
+      #   # Returns the first item in the collection if present:
+      #   # Called via GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   @user.email # => "remi@example.com"
+      #   @user.new? # => true
+      def find_or_initialize_by(attributes)
+        find_by(attributes) || build(attributes)
+      end
+
+      # Create a resource and return it
+      #
+      # @example
+      #   @user = User.create(:fullname => "Tobias Fünke")
+      #   # Called via POST "/users/1" with `&fullname=Tobias+Fünke`
+      #
+      # @example
+      #   @user = User.where(:email => "tobias@bluth.com").create(:fullname => "Tobias Fünke")
+      #   # Called via POST "/users/1" with `&email=tobias@bluth.com&fullname=Tobias+Fünke`
+      def create(attributes = {})
+        attributes ||= {}
+        resource = @parent.new(@params.merge(attributes))
+        resource.save
+
+        resource
+      end
+
+      # Fetch a resource and create it if it's not found
+      #
+      # @example
+      #   @user = User.where(:email => "remi@example.com").find_or_create
+      #
+      #   # Returns the first item of the collection if present:
+      #   # GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   # POST /users with `email=remi@example.com`
+      def first_or_create(attributes = {})
+        fetch.first || create(attributes)
+      end
+
+      # Fetch a resource and build it if it's not found
+      #
+      # @example
+      #   @user = User.where(:email => "remi@example.com").find_or_initialize
+      #
+      #   # Returns the first item of the collection if present:
+      #   # GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   @user.email # => "remi@example.com"
+      #   @user.new? # => true
+      def first_or_initialize(attributes = {})
+        fetch.first || build(attributes)
+      end
+
+      # @private
+      def clear_fetch_cache!
+        instance_variable_set(:@_fetch, nil)
+      end
+    end
+  end
+end

data/lib/restorm/model.rb

@@ -0,0 +1,75 @@
+require "restorm/model/base"
+require "restorm/model/deprecated_methods"
+require "restorm/model/http"
+require "restorm/model/attributes"
+require "restorm/model/relation"
+require "restorm/model/orm"
+require "restorm/model/parse"
+require "restorm/model/associations"
+require "restorm/model/introspection"
+require "restorm/model/paths"
+require "restorm/model/nested_attributes"
+require "active_model"
+
+module Restorm
+  # This module is the main element of Restorm. After creating a Restorm::API object,
+  # include this module in your models to get a few magic methods defined in them.
+  #
+  # @example
+  #   class User
+  #     include Restorm::Model
+  #   end
+  #
+  #   @user = User.new(:name => "Rémi")
+  #   @user.save
+  module Model
+    extend ActiveSupport::Concern
+
+    # Restorm modules
+    include Restorm::Model::Base
+    include Restorm::Model::DeprecatedMethods
+    include Restorm::Model::Attributes
+    include Restorm::Model::ORM
+    include Restorm::Model::HTTP
+    include Restorm::Model::Parse
+    include Restorm::Model::Introspection
+    include Restorm::Model::Paths
+    include Restorm::Model::Associations
+    include Restorm::Model::NestedAttributes
+
+    # Supported ActiveModel modules
+    include ActiveModel::AttributeMethods
+    include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
+    include ActiveModel::Conversion
+    include ActiveModel::Dirty
+
+    # Class methods
+    included do
+      # Assign the default API
+      use_api Restorm::API.default_api
+      method_for :create, :post
+      method_for :update, :put
+      method_for :find, :get
+      method_for :destroy, :delete
+      method_for :new, :get
+
+      # Define the default primary key
+      primary_key :id
+
+      # Define default storage accessors for errors and metadata
+      store_response_errors :response_errors
+      store_metadata :metadata
+
+      # Include ActiveModel naming methods
+      extend ActiveModel::Translation
+
+      # Configure ActiveModel callbacks
+      extend ActiveModel::Callbacks
+      define_model_callbacks :create, :update, :save, :find, :destroy, :initialize
+
+      # Define matchers for attr? and attr= methods
+      define_attribute_method_matchers
+    end
+  end
+end

data/lib/restorm/version.rb

@@ -0,0 +1,3 @@
+module Restorm
+  VERSION = "1.0.0"
+end

data/lib/restorm.rb

@@ -0,0 +1,19 @@
+require "restorm/version"
+
+require "multi_json"
+require "faraday"
+require "active_support"
+require "active_support/inflector"
+require "active_support/core_ext/hash"
+
+require "restorm/model"
+require "restorm/api"
+require "restorm/middleware"
+require "restorm/errors"
+require "restorm/collection"
+
+module Restorm
+  module JsonApi
+    autoload :Model, 'restorm/json_api/model'
+  end
+end

data/restorm.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "restorm/version"
+
+Gem::Specification.new do |s|
+  s.name        = "restorm"
+  s.version     = Restorm::VERSION
+  s.authors     = ["Rémi Prévost", "Kates Gasis"]
+  s.email       = ["katesgasis@gmail.com"]
+  s.homepage    = "https://github.com/kates/restorm"
+  s.license     = "MIT"
+  s.summary     = "A simple Representational State Transfer-based Hypertext Transfer Protocol-powered Object Relational Mapper."
+  s.description = "Restorm is an ORM that maps REST resources and collections to Ruby objects"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "json", "~> 2.6.3"
+  s.add_development_dependency "rake", "~> 13.0.6"
+  s.add_development_dependency "rspec", "~> 3.12"
+
+  s.add_runtime_dependency "activemodel", ">= 4.2.1"
+  s.add_runtime_dependency "faraday", "~> 2.7.4"
+
+  s.add_runtime_dependency "multi_json", "~> 1.15.0"
+end

data/spec/api_spec.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Restorm::API do
+  subject { Restorm::API.new }
+
+  context "initialization" do
+    describe "#setup" do
+      context "when setting custom middleware" do
+        before do
+          class Foo; end
+          class Bar; end
+
+          subject.setup url: "https://api.example.com" do |connection|
+            connection.use Foo
+            connection.use Bar
+          end
+        end
+
+        specify { expect(subject.connection.builder.handlers).to eq([Foo, Bar]) }
+      end
+
+      context "when setting custom options" do
+        before { subject.setup foo: { bar: "baz" }, url: "https://api.example.com" }
+
+        describe "#options" do
+          it { expect(subject.options).to eq(foo: { bar: "baz" }, url: "https://api.example.com") }
+        end
+      end
+    end
+
+    describe "#request" do
+      before do
+        class SimpleParser < Faraday::Middleware
+
+          def on_complete(env)
+            env[:body] = { data: env[:body] }
+          end
+        end
+      end
+
+      context "making HTTP requests" do
+        let(:parsed_data) { subject.request(_method: :get, _path: "/foo")[:parsed_data] }
+        before do
+          subject.setup url: "https://api.example.com" do |builder|
+            builder.use SimpleParser
+            builder.adapter(:test) { |stub| stub.get("/foo") { [200, {}, "Foo, it is."] } }
+          end
+        end
+
+        specify { expect(parsed_data[:data]).to eq("Foo, it is.") }
+      end
+
+      context "making HTTP requests while specifying custom HTTP headers" do
+        let(:parsed_data) { subject.request(_method: :get, _path: "/foo", _headers: { "X-Page" => 2 })[:parsed_data] }
+
+        before do
+          subject.setup url: "https://api.example.com" do |builder|
+            builder.use SimpleParser
+            builder.adapter(:test) { |stub| stub.get("/foo") { |env| [200, {}, "Foo, it is page #{env[:request_headers]['X-Page']}."] } }
+          end
+        end
+
+        specify { expect(parsed_data[:data]).to eq("Foo, it is page 2.") }
+      end
+
+      context "parsing a request with the default parser" do
+        let(:parsed_data) { subject.request(_method: :get, _path: "users/1")[:parsed_data] }
+        before do
+          subject.setup url: "https://api.example.com" do |builder|
+            builder.use Restorm::Middleware::FirstLevelParseJSON
+            builder.adapter :test do |stub|
+              stub.get("/users/1") { [200, {}, MultiJson.dump(id: 1, name: "George Michael Bluth", errors: ["This is a single error"], metadata: { page: 1, per_page: 10 })] }
+            end
+          end
+        end
+
+        specify do
+          expect(parsed_data[:data]).to eq(id: 1, name: "George Michael Bluth")
+          expect(parsed_data[:errors]).to eq(["This is a single error"])
+          expect(parsed_data[:metadata]).to eq(page: 1, per_page: 10)
+        end
+      end
+
+      context "parsing a request with a custom parser" do
+        let(:parsed_data) { subject.request(_method: :get, _path: "users/1")[:parsed_data] }
+        before do
+          class CustomParser < Faraday::Middleware
+
+            def on_complete(env)
+              json = MultiJson.load(env[:body], symbolize_keys: true)
+              errors = json.delete(:errors) || []
+              metadata = json.delete(:metadata) || {}
+              env[:body] = {
+                data: json,
+                errors: errors,
+                metadata: metadata
+              }
+            end
+          end
+
+          subject.setup url: "https://api.example.com" do |builder|
+            builder.use CustomParser
+            builder.use Faraday::Request::UrlEncoded
+            builder.adapter :test do |stub|
+              stub.get("/users/1") { [200, {}, MultiJson.dump(id: 1, name: "George Michael Bluth")] }
+            end
+          end
+        end
+
+        specify do
+          expect(parsed_data[:data]).to eq(id: 1, name: "George Michael Bluth")
+          expect(parsed_data[:errors]).to eq([])
+          expect(parsed_data[:metadata]).to eq({})
+        end
+      end
+    end
+  end
+end

data/spec/collection_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Restorm::Collection do
+  let(:items) { [1, 2, 3, 4] }
+  let(:metadata) { { name: "Testname" } }
+  let(:errors) { { name: ["not_present"] } }
+
+  describe "#new" do
+    context "without parameters" do
+      subject { Restorm::Collection.new }
+
+      it { is_expected.to eq([]) }
+
+      describe "#metadata" do
+        subject { super().metadata }
+        it { is_expected.to eq({}) }
+      end
+
+      describe "#errors" do
+        subject { super().errors }
+        it { is_expected.to eq({}) }
+      end
+    end
+
+    context "with parameters" do
+      subject { Restorm::Collection.new(items, metadata, errors) }
+
+      it { is_expected.to eq([1, 2, 3, 4]) }
+
+      describe "#metadata" do
+        subject { super().metadata }
+        it { is_expected.to eq(name: "Testname") }
+      end
+
+      describe "#errors" do
+        subject { super().errors }
+        it { is_expected.to eq(name: ["not_present"]) }
+      end
+    end
+  end
+end

data/spec/json_api/model_spec.rb

@@ -0,0 +1,169 @@
+require "spec_helper"
+
+describe Restorm::JsonApi::Model do
+  before do
+    Restorm::API.setup url: "https://api.example.com" do |connection|
+      connection.use Restorm::Middleware::JsonApiParser
+      connection.adapter :test do |stub|
+        stub.get("/users/1") do
+          [
+            200,
+            {},
+            {
+              data: {
+                id:    1,
+                type: "users",
+                attributes: {
+                  name: "Roger Federer"
+                }
+              }
+
+            }.to_json
+          ]
+        end
+
+        stub.get("/users") do
+          [
+            200,
+            {},
+            {
+              data: [
+                {
+                  id:    1,
+                  type: "users",
+                  attributes: {
+                    name: "Roger Federer"
+                  }
+                },
+                {
+                  id:    2,
+                  type: "users",
+                  attributes: {
+                    name: "Kei Nishikori"
+                  }
+                }
+              ]
+            }.to_json
+          ]
+        end
+
+        stub.post("/users", data:
+        {
+          type: "users",
+          attributes: {
+            name: "Jeremy Lin"
+          }
+        }) do
+          [
+            201,
+            {},
+            {
+              data: {
+                id:    3,
+                type: "users",
+                attributes: {
+                  name: "Jeremy Lin"
+                }
+              }
+
+            }.to_json
+          ]
+        end
+
+        stub.patch("/users/1", data:
+        {
+          type: "users",
+          id: 1,
+          attributes: {
+            name: "Fed GOAT"
+          }
+        }) do
+          [
+            200,
+            {},
+            {
+              data: {
+                id:    1,
+                type: "users",
+                attributes: {
+                  name: "Fed GOAT"
+                }
+              }
+
+            }.to_json
+          ]
+        end
+
+        stub.delete("/users/1") do
+          [204, {}, {}]
+        end
+      end
+    end
+
+    spawn_model("Foo::User", type: Restorm::JsonApi::Model)
+  end
+
+  it "allows configuration of type" do
+    spawn_model("Foo::Bar", type: Restorm::JsonApi::Model) do
+      type :foobars
+    end
+
+    expect(Foo::Bar.instance_variable_get("@type")).to eql("foobars")
+  end
+
+  it "finds models by id" do
+    user = Foo::User.find(1)
+    expect(user.attributes).to eql(
+      "id" => 1,
+      "name" => "Roger Federer"
+    )
+  end
+
+  it "finds a collection of models" do
+    users = Foo::User.all
+    expect(users.map(&:attributes)).to match_array(
+      [
+        {
+          "id" => 1,
+          "name" => "Roger Federer"
+        },
+        {
+          "id" => 2,
+          "name" => "Kei Nishikori"
+        }
+      ]
+    )
+  end
+
+  it "creates a Foo::User" do
+    user = Foo::User.new(name: "Jeremy Lin")
+    user.save
+    expect(user.attributes).to eql(
+      "id" => 3,
+      "name" => "Jeremy Lin"
+    )
+  end
+
+  it "updates a Foo::User" do
+    user = Foo::User.find(1)
+    user.name = "Fed GOAT"
+    user.save
+    expect(user.attributes).to eql(
+      "id" => 1,
+      "name" => "Fed GOAT"
+    )
+  end
+
+  it "destroys a Foo::User" do
+    user = Foo::User.find(1)
+    expect(user.destroy).to be_destroyed
+  end
+
+  context "undefined methods" do
+    it "removes methods that are not compatible with json api" do
+      [:parse_root_in_json, :include_root_in_json, :root_element, :primary_key].each do |method|
+        expect { Foo::User.new.send(method, :foo) }.to raise_error NoMethodError, "Restorm::JsonApi::Model does not support the #{method} configuration option"
+      end
+    end
+  end
+end

data/spec/middleware/accept_json_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Restorm::Middleware::AcceptJSON do
+  it "adds an Accept header" do
+    described_class.new.add_header({}).tap do |headers|
+      expect(headers["Accept"]).to eq("application/json")
+    end
+  end
+end