activeresource_json_patch 0.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+*.sw?

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    yasm (0.0.0)
+      activeresource (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    builder (2.1.2)
+    cucumber (0.10.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (>= 2.3.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.3.6)
+      json (>= 1.4.6)
+    i18n (0.5.0)
+    json (1.5.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber (~> 0.10.0)
+  rspec (~> 2.4.0)
+  yasm!

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/activeresource_json_patch.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = %q{activeresource_json_patch}
+  s.version = File.read "VERSION"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Parker"]
+  s.date = %q{2011-04-24}
+  s.summary = %q{JSON fix for ActiveResource (Rails 3).}
+  s.description = %q{Fixes json formatting problem with ActiveResource.}
+  s.email = %q{moonmaster9000@gmail.com}
+  s.extra_rdoc_files = [
+    "readme.md"
+  ]
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+ 
+  s.homepage = %q{http://github.com/moonmaster9000/activeresource_json_patch}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  
+  s.add_dependency(%q<activeresource>, ["~> 3.0"])
+  s.add_development_dependency(%q<cucumber>, ["~> 0.10.0"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.4.0"])
+end

data/features/include_root_in_json.feature

@@ -0,0 +1,44 @@
+Feature: Include the root (and only the root) in the JSON
+  
+  Scenario: Including the root in the JSON, but not adding roots to any child elements
+    Given that "/books/2001-space-odyssey.json" returns:
+      """
+      {
+        "title": "2001: A Space Odyssey",
+        "id": "2001-space-odyssey",
+        "genres": [
+          {
+            "name": "Fiction",
+            "id": "fiction"
+          },
+          {
+            "name": "Science Fiction",
+            "id": "science-fiction"
+          }
+        ],
+        "author": nil
+      }
+      """
+    When I retrieve the book via ActiveResource
+    And I change the author to "Arthur C. Clarke"
+    And I save the book
+    Then ActiveResource should send the following back to the server:
+      """
+      {
+        "book": {
+          "author": "Arthur C. Clarke",
+          "title": "2001: A Space Odyssey",
+          "id": "2001-space-odyssey",
+          "genres": [
+            {
+              "name": "Fiction",
+              "id": "fiction"
+            },
+            {
+              "name": "Science Fiction",
+              "id": "science-fiction"
+            }
+          ]
+        }
+      }
+      """

data/features/step_definitions/include_root_in_json_steps.rb

@@ -0,0 +1,27 @@
+Given /^that "([^"]*)" returns:$/ do |path, json_get_body|
+  @path = path
+  ActiveResource::HttpMock.respond_to do |mock|
+    mock.get @path, {}, json_get_body
+  end
+end
+
+When /^I retrieve the book via ActiveResource$/ do
+  class Book < ActiveResource::Base; self.site = 'http://www.example.com'; self.format = :json; end
+  @book = Book.find "2001-space-odyssey"
+end
+
+When /^I change the author to "([^"]*)"$/ do |author|
+  @book.author = author
+end
+
+When /^I save the book$/ do
+
+end
+
+Then /^ActiveResource should send the following back to the server:$/ do |book_body|
+  update_book      = ActiveResource::Request.new(:put, @path, book_body.gsub(/^\s+/, "").gsub("\n", "").gsub(": \"", ":\""), {"Content-Type" => "application/json"})
+  updated_response = ActiveResource::Response.new("", 204, {"Location" => @path})
+  ActiveResource::HttpMock.respond_to({update_book => updated_response})
+  @book.save
+  ActiveResource::HttpMock.requests.include?(update_book).should be_true
+end

data/features/support/env.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift './lib'
+require 'activeresource_json_patch'
+require 'rspec/mocks/standalone'

data/lib/activeresource_json_patch.rb

@@ -0,0 +1,17 @@
+require 'active_resource'
+
+module ActiveResource
+  class Base
+    def encode_with_json(options={})
+      case self.class.format
+        when ActiveResource::Formats[:json]
+          data = self.class.include_root_in_json ? {self.class.element_name => attributes} : attributes
+          self.class.format.encode data
+        else
+          encode_without_json(options)
+      end
+    end
+
+    alias_method_chain :encode, :json
+  end
+end

data/readme.md

@@ -0,0 +1,91 @@
+# ActiveResource JSON Patch
+  
+Why? Because the ActiveResource (Rails 3) JSON format is broken, and this gem will fix it until ActiveResource gets patched. 
+
+## The problem
+
+Imagine you fetch a book over ActiveResource. 
+
+    @book = Book.find '2001-space-odyssey'
+
+The JSON that came to you looked like this: 
+
+    {
+      "title": "2001: A Space Odyssey",
+      "id": "2001-space-odyseey",
+      "genres": [
+        {
+          "name": "Fiction",
+          "id": "fiction"
+        },
+        {
+          "name": "Science Fiction",
+          "id": "science-fiction"
+        }
+      ],
+      "author": nil
+    }
+
+So far, so good. 
+
+Now, let's update the author attribute and save it. 
+
+    @book.author = "Arthur C. Clarke"
+    @book.save
+
+Great! But wait, let's inspect the JSON that it sent to the server on save:
+
+    {
+      "book": {
+        "title": "2001: A Space Odyssey",
+        "id": "2001-space-odyseey",
+        "genres": [
+          {
+            "genre": {
+              "name": "Fiction",
+              "id": "fiction"
+            }
+          },
+          {
+            "genre": {
+              "name": "Science Fiction",
+              "id": "science-fiction"
+            }
+          }
+        ],
+        "author": "Arthur C. Clarke"
+      }
+    }
+
+Not cool! By default, `ActiveResource::Base.include_root_in_json` is `true` - which is fine. Except it doesn't just include the `"book"` root, it added `"genre"` roots 
+to all of the `"genres"`! This will completely fuck up your document. 
+
+## The Solution
+
+Step 1: Install this gem, `activeresource_json_patch`: either add it to your `Gemfile` and `bundle install`, or simply `gem install activeresource_json_patch`
+
+Step 2: Require it in your codebase. If you included this in a Rails project via a `Gemfile`, then you're good to go. Otherwise, `require activeresource_json_patch` somewhere in your code.
+
+Now, with the gem installed and loaded, were you to repeat the above steps, the JSON it will would send back would not inlude the superfluous `"genre"` roots:
+
+    {
+      "book": {
+        "title": "2001: A Space Odyssey",
+        "id": "2001-space-odyseey",
+        "genres": [
+          {
+            "name": "Fiction",
+            "id": "fiction"
+          },
+          {
+            "name": "Science Fiction",
+            "id": "science-fiction"
+          }
+        ],
+        "author": "Arthur C. Clarke"
+      }
+    }
+
+## LICENSE
+
+None. This is PUBLIC DOMAIN. Do ANYTHING!

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: activeresource_json_patch
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Matt Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id003
+description: Fixes json formatting problem with ActiveResource.
+email: moonmaster9000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- readme.md
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- VERSION
+- activeresource_json_patch.gemspec
+- features/include_root_in_json.feature
+- features/step_definitions/include_root_in_json_steps.rb
+- features/support/env.rb
+- lib/activeresource_json_patch.rb
+- readme.md
+has_rdoc: true
+homepage: http://github.com/moonmaster9000/activeresource_json_patch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: JSON fix for ActiveResource (Rails 3).
+test_files: 
+- features/include_root_in_json.feature
+- features/step_definitions/include_root_in_json_steps.rb
+- features/support/env.rb