amfetamine 0.3.3 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dff766487153f39f4c3031ea1ac716f296fbdf2
+  data.tar.gz: 3a9435fdea9c38bda128504c9e74ecc044b15363
+SHA512:
+  metadata.gz: 19d8b378c2ddcc16ad185c32c8f04b043c3b640307dc11c3e460bee9006edf57cff3dabf9bdfd8eba60802dcb3af5af8b51615933c0d0eb5c8f03036fcceea88
+  data.tar.gz: b6bb834912b00d0e08a215ebfd0fa5e8aa5a37f37c5ded634bd1b5e821f2d64dc5c0959b0ffcf60595994a77eedd1df3b33e025ae36806667028a9161a771a31

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
-  - 1.9.2
   - rbx-19mode
   - jruby-19mode

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0
+
+* Add default cache settings (10 minutes)
+
 ## 0.3.3
 
 * fix for double Array error messages bug for remote (server) validations [Issue #6]

data/README.md

@@ -1,5 +1,6 @@
-Amfetamine, A REST object abstractavaganza
-====================================
+# Amfetamine
+
+A REST object abstractavaganza
 
 > Rest abstraction on steroids that makes shit go boom!
 
@@ -34,15 +35,13 @@ It is still in beta and under heavy development. Some features:
 Setup
 =====
 
-### 1)
-Add it to your gemfile:
+### 1) Add it to your gemfile:
 
 ```ruby
 gem 'amfetamine'
 ```
 
-### 2)
-Create an initializer, note that you can also do this on a per object basis:
+### 2) Create an initializer, note that you can also do this on a per object basis:
 
 ```ruby
 #config/initializers/amfetamine_config.rb
@@ -56,15 +55,14 @@ Amfetamine::Config.configure do |config|
 end
 ```
 
-On Heroku your `memcached_instance` variable can look like this (with the memcached addon enabled):
+On Heroku your `memcached_instance` variable can look like this (with the [memcachier](https://addons.heroku.com/memcachier) addon enabled):
 
 ```ruby
-config.memcached_instance = "memcached://#{ENV['MEMCACHE_USERNAME']}:#{ENV['MEMCACHE_PASSWORD']}@#{ENV['MEMCACHE_SERVERS']}:11211"
+config.memcached_instance = "memcached://#{ENV['MEMCACHIER_USERNAME']}:#{ENV['MEMCACHIER_PASSWORD']}@#{ENV['MEMCACHIER_SERVERS']}"
 ```
 
 
-### 3)
-Configure your object:
+### 3) Configure your object:
 
 ```ruby
 class Banana < Amfetamine::Base
@@ -77,8 +75,7 @@ end
 ```
 
 
-### 4)
-Lastly, because I think its more semantic, you need to configure both your service and client to include the root element in JSON. However, Amfetamine will work fine without this.
+### 4) Lastly, because I think its more semantic, you need to configure both your service and client to include the root element in JSON. However, Amfetamine will work fine without this.
 
 ```ruby
 # config/initializers/wrap_parameters.rb
@@ -143,6 +140,21 @@ object.update_attributes(HASH)
 Object.create(HASH)
 ```
 
+
+Caching
+=======
+
+By default, all requests are cached. Default expiration time is set to 10 minutes. If you want to change it, you can do so when initializing the memcached client (see #2 above in setting up), like this:
+
+```ruby
+Amfetamine::Config.configure do |config|
+  config.memcached_instance = "memcached://user:pass@host:port:weight", { expires_in: 60.minutes }
+end
+```
+
+When Amfetamine is required in a Rails application it disables caching altogether in `test` environment and sets the `expires_in` to 60 seconds in `development` environment.
+
+
 Cache Invalidation
 =================
 
@@ -221,8 +233,7 @@ Future Features & TODO
 Licence
 =======
 
-
-Copyright (C) 2012 Exvo.com, Timon Vonk
+Copyright (C) 2012-2013 Exvo.com, Timon Vonk
 
 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:
 
@@ -230,6 +241,7 @@ The above copyright notice and this permission notice shall be included in all c
 
 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.
 
+
 Contributing
 ============
 
@@ -242,5 +254,6 @@ Contributing
 Contributors
 ============
 
-* Timon Vonk
-* Matt Bridges
+* [Timon Vonk](https://github.com/timonv)
+* [Matt Bridges](https://github.com/mattdbridges)
+* [Paweł Gościcki](https://github.com/pjg)

data/lib/amfetamine.rb

@@ -16,8 +16,8 @@ module Amfetamine
     Amfetamine::Logger.instance
   end
 
-  # If included in Rails, disable caching in dev/test modes
-  if defined?(Rails) && (Rails.env.development? || Rails.env.test?)
+  # Disable chaching in test mode (if included in Rails)
+  if defined?(Rails) && Rails.env.test?
     Amfetamine::Config.disable_caching = true
   end
 end

data/lib/amfetamine/config.rb

@@ -10,7 +10,8 @@ module Amfetamine
       end
 
       def memcached_instance=(servers, options={})
-        @memcached_instance ||= Dalli::Client.new(servers, options)
+        opts = default_memcached_options.merge(options)
+        @memcached_instance ||= Dalli::Client.new(servers, opts)
       end
 
       def rest_client=(value)
@@ -32,6 +33,32 @@ module Amfetamine
       def disable_caching=(value)
         @disable_caching = value
       end
+
+      private
+
+      def default_memcached_options
+        {
+          expires_in: expiration_time
+        }
+      end
+
+      def expiration_time
+        if defined?(Rails)
+          method = "expiration_time_for_#{ Rails.env }"
+          return send(method) if defined?(method)
+        end
+
+        default_expiration_time
+      end
+
+      def expiration_time_for_development
+        60.seconds
+      end
+
+      def default_expiration_time
+        10.minutes
+      end
+
     end
   end
 end

data/lib/amfetamine/version.rb

@@ -1,3 +1,3 @@
 module Amfetamine
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/spec/amfetamine/base_spec.rb

@@ -2,6 +2,20 @@ require 'spec_helper'
 
 # Integration tests :)
 describe Amfetamine::Base do
+
+  describe 'initialization' do
+    let(:memcached_instance) { Amfetamine::Config.memcached_instance }
+    let(:options) { memcached_instance.instance_variable_get(:@options) }
+
+    it 'passes :expires_in option to Dalli::Client' do
+      options.should include(:expires_in)
+    end
+
+    specify 'exires_in option is set to an integer value' do
+      options[:expires_in].should be_an_integer
+    end
+  end
+
   describe "Dummy, our ever faitful test subject" do
     # Some hight level tests, due to the complexity this makes it a lot easier to refactor
     let(:dummy) { build(:dummy) }
@@ -10,8 +24,8 @@ describe Amfetamine::Base do
     it { should be_valid }
     its(:title) { should ==('Dummy')}
     its(:description) { should ==('Crash me!')}
-    its(:to_json) { should match(/dummy/) }
-
+    its(:to_json) { should match(/Dummy/) }
+    its(:to_json) { should match(/Crash me\!/) }
   end
 
   describe "Class dummy, setup with Amfetamine::Base" do
@@ -155,22 +169,23 @@ describe Amfetamine::Base do
     end
 
     context "#save" do
-      let(:dummy2) { dummy.dup}
-      before(:each) do
+      let!(:post_dummy) { dummy.dup }
+
+      before do
         dummy.send(:notsaved=, true)
-        dummy2 = dummy.dup
         dummy.send(:id=, nil)
       end
 
       it "should update the id if data is received from post" do
-        old_id = dummy.id
-        Dummy.prevent_external_connections! do |r|
-          r.post(code:201) { dummy2 }
+        dummy.id.should be_nil
 
+        Dummy.prevent_external_connections! do |r|
+          r.post(code:201) { post_dummy }
           dummy.save
         end
-        dummy.id.should == old_id
-        dummy.attributes[:id].should == old_id
+
+        dummy.id.should == post_dummy.id
+        dummy.attributes[:id].should == post_dummy.id
       end
 
       it "should update attributes if data is received from update" do

data/tmp/rspec_guard_result

@@ -0,0 +1 @@
+

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amfetamine
 version: !ruby/object:Gem::Version
-  version: 0.3.3
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Timon Vonk
@@ -10,262 +9,230 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2013-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: dalli
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Provides an interface to REST apis with objects and a cache. Zero effort!
@@ -277,7 +244,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
 - .travis.yml
 - .vagrant
 - CHANGELOG.md
@@ -319,53 +285,28 @@ files:
 - spec/helpers/active_model_lint.rb
 - spec/helpers/id_pool.rb
 - spec/spec_helper.rb
+- tmp/rspec_guard_result
 homepage: http://www.github.com/exvo/amfetamine
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1384160561817165326
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1384160561817165326
 requirements: []
 rubyforge_project: amfetamine
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: REST object abstraction on steroids the makes shit go boom!
-test_files:
-- spec/amfetamine/base_spec.rb
-- spec/amfetamine/caching_spec.rb
-- spec/amfetamine/callbacks_spec.rb
-- spec/amfetamine/conditions_spec.rb
-- spec/amfetamine/dummy_spec.rb
-- spec/amfetamine/dynamic_attributes_spec.rb
-- spec/amfetamine/relationships_spec.rb
-- spec/amfetamine/rest_helpers_spec.rb
-- spec/amfetamine/rspec_matchers_spec.rb
-- spec/amfetamine/testing_helpers_spec.rb
-- spec/dummy/child.rb
-- spec/dummy/dummy.rb
-- spec/dummy/dummy_rest_client.rb
-- spec/dummy/infant.rb
-- spec/dummy/student.rb
-- spec/dummy/teacher.rb
-- spec/helpers/active_model_lint.rb
-- spec/helpers/id_pool.rb
-- spec/spec_helper.rb
+test_files: []

data/.rspec

@@ -1,2 +0,0 @@
---color
---profile