hotchoc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 772df776e809aa41302d368813a4378aed3f4cc0
-  data.tar.gz: 060a43cfd5352ab0ac2ee6aa7e637efc28c5314f
+  metadata.gz: 5a893ac926a79c8737afa2810911b2231cd5ad46
+  data.tar.gz: 0ec2c6f3085b60587ff1208c5b6de95994962786
 SHA512:
-  metadata.gz: 0485bb80b24c5520f951394ecb880214f89ab800a27d2d2d01bbf5350c9a3bb172622fa5a12f3f51ea7f119a144b12a68d6c545f07e8fdc154aae4529f9644dd
-  data.tar.gz: 8ef2d166f82a28e3f67ade1a05f2d68cc93acacce629a00b2ba0ec713a34ad19ddd9d68007ae13ff05fb98f238e8f3ab2246b6d9861a76d9c72293e2bba15486
+  metadata.gz: 48ac708583876ad9f9aff17ef88aaef4ba59e51c2df0fdcfd9e7bba7c5e796162807798d4cb76f52a22ad299c73064cf2c0ba098f6b59614c533d4887f42fc6a
+  data.tar.gz: 4483599c8dd62fe8d3a95144fade6f36b853da36f641c9e6dc5c0fae5bab0a50db4848feb12f7ba7631b693c73ca2d7e50a79df52c5b36b971bcbe7d532a7c07

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.DS_Store
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rubocop.yml

@@ -0,0 +1,558 @@
+AllCops:
+  RunRailsCops: true
+
+
+Style/AccessModifierIndentation:
+  Enabled: true
+  EnforcedStyle: indent
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/Alias:
+  Enabled: true
+
+Style/AlignArray:
+  Enabled: true
+
+Style/AlignHash:
+  Enabled: false
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/ArrayJoin:
+  Enabled: true
+
+Style/AsciiComments:
+  Enabled: true
+
+Style/AsciiIdentifiers:
+  Enabled: true
+
+Style/Attr:
+  Enabled: false
+
+Style/BeginBlock:
+  Enabled: false
+
+Style/BlockComments:
+  Enabled: false
+
+Style/BlockNesting:
+  Enabled: false
+
+Style/Blocks:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: true
+
+Style/CaseIndentation:
+  Enabled: true
+
+Style/CharacterLiteral:
+  Enabled: false
+
+Style/ClassAndModuleCamelCase:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ClassCheck:
+  Enabled: true
+
+Style/ClassLength:
+  Enabled: false
+
+Style/ClassMethods:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: false
+
+Style/ColonMethodCall:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/CommentIndentation:
+  Enabled: true
+
+Style/ConstantName:
+  Enabled: false
+
+Style/CyclomaticComplexity:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/DeprecatedHashMethods:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: true
+
+Style/EmptyLineBetweenDefs:
+  Enabled: true
+
+Style/EmptyLines:
+  Enabled: false
+
+Style/EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+Style/EmptyLinesAroundBody:
+  Enabled: false
+
+Style/EmptyLiteral:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/EndBlock:
+  Enabled: false
+
+Style/EndOfLine:
+  Enabled: true
+
+Style/EvenOdd:
+  Enabled: false
+
+Style/FileName:
+  Enabled: true
+
+Style/FlipFlop:
+  Enabled: false
+
+Style/For:
+  Enabled: true
+
+Style/FormatString:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/IfWithSemicolon:
+  Enabled: false
+
+Style/IndentationConsistency:
+  Enabled: true
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/IndentArray:
+  Enabled: false
+
+Style/IndentHash:
+  Enabled: false
+
+Style/InlineComment:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: true
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/LeadingCommentSpace:
+  Enabled: false
+
+Style/LineEndConcatenation:
+  Enabled: false
+
+Style/LineLength:
+  Max: 198
+  Enabled: true
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/MethodCallParentheses:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/MethodLength:
+  Enabled: false
+
+Style/MethodName:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/MultilineIfThen:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/NegatedWhile:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false
+
+Style/Next:
+  Enabled: true
+
+Style/NilComparison:
+  Enabled: false
+
+Style/NonNilCheck:
+  Enabled: false
+
+Style/Not:
+  Enabled: true
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/OneLineConditional:
+  Enabled: false
+
+Style/OpMethod:
+  Enabled: false
+
+Style/ParameterLists:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/Proc:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/RedundantException:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/SelfAssignment:
+  Enabled: true
+
+Style/Semicolon:
+  Enabled: true
+
+Style/SignalException:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: true
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: true
+
+Style/SpaceAfterColon:
+  Enabled: true
+
+Style/SpaceAfterComma:
+  Enabled: true
+
+Style/SpaceAfterControlKeyword:
+  Enabled: false
+
+Style/SpaceAfterMethodName:
+  Enabled: false
+
+Style/SpaceAfterNot:
+  Enabled: false
+
+Style/SpaceAfterSemicolon:
+  Enabled: false
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Style/SpaceBeforeComma:
+  Enabled: true
+
+Style/SpaceBeforeComment:
+  Enabled: true
+
+Style/SpaceBeforeSemicolon:
+  Enabled: true
+
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Style/SpaceAroundOperators:
+  Enabled: true
+
+Style/SpaceBeforeModifierKeyword:
+  Enabled: true
+
+Style/SpaceInsideBrackets:
+  Enabled: true
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Style/SpaceInsideParens:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/Tab:
+  Enabled: true
+
+Style/Tab:
+  Enabled: true
+
+Style/TrailingBlankLines:
+  Enabled: true
+
+Style/TrailingComma:
+  Enabled: false
+
+Style/TrailingWhitespace:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/UnlessElse:
+  Enabled: true
+
+Style/UnneededCapitalW:
+  Enabled: true
+
+Style/UnneededPercentQ:
+  Enabled: true
+
+Style/UnneededPercentX:
+  Enabled: true
+
+Style/VariableInterpolation:
+  Enabled: false
+
+Style/VariableName:
+  Enabled: false
+
+Style/WhenThen:
+  Enabled: true
+
+Style/WhileUntilDo:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+#################### Lint ################################
+### Warnings
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/BlockAlignment:
+  Enabled: false
+
+Lint/ConditionPosition:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: true
+
+Lint/DefEndAlignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/ElseLayout:
+  Enabled: false
+
+Lint/EmptyEnsure:
+  Enabled: true
+
+Lint/EmptyInterpolation:
+  Enabled: true
+
+Lint/EndAlignment:
+  Enabled: true
+  AlignWith: variable
+
+Lint/EndInMethod:
+  Enabled: false
+
+Lint/EnsureReturn:
+  Enabled: false
+
+Lint/Eval:
+  Enabled: true
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/InvalidCharacterLiteral:
+  Enabled: false
+
+Lint/LiteralInCondition:
+  Enabled: false
+
+Lint/LiteralInInterpolation:
+  Enabled: false
+
+Lint/Loop:
+  Enabled: false
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: false
+
+Lint/RequireParentheses:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Lint/SpaceBeforeFirstArg:
+  Enabled: true
+
+Lint/StringConversionInInterpolation:
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Lint/UnreachableCode:
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Lint/UselessComparison:
+  Enabled: true
+
+Lint/UselessElseWithoutRescue:
+  Enabled: true
+
+Lint/UselessSetterCall:
+  Enabled: true
+
+Lint/Void:
+  Enabled: true
+
+##################### Rails ##################################
+
+Rails/ActionFilter:
+  Enabled: true
+
+Rails/DefaultScope:
+  Enabled: false
+
+Rails/Delegate:
+  Enabled: true
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+Rails/Output:
+  Enabled: false
+
+Rails/ReadWriteAttribute:
+  Enabled: false
+
+Rails/ScopeArgs:
+  Enabled: false
+
+Rails/Validation:
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## Master
+
+## 0.2.0
+
+[Full changelog](https://github.com/choc/hotchoc-ruby/compare/v0.1.0...v0.2.0)
+
+Major changes:
+
+* Wrap responses in presenter objects instead of returning raw JSON
+* Fields 'hidden' and 'excerpt' were dropped from albums, pages and posts
+* Single resource APIs were removed
+
+Enhancements:
+
+* Added RuboCop
+* Various code improvements
+
 ## 0.1.0
 
 [Full changelog](https://github.com/choc/hotchoc-ruby/compare/v0.0.1...v0.1.0)

data/README.md

@@ -2,6 +2,9 @@
 
 Official Ruby wrapper for the Hotchoc API (in private beta).
 
+[![Gem Version](https://badge.fury.io/rb/hotchoc.svg)](http://badge.fury.io/rb/hotchoc)
+[![Code Climate](https://codeclimate.com/github/choc/hotchoc-ruby.png)](https://codeclimate.com/github/choc/hotchoc-ruby)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,26 +29,19 @@ Or install it manually as:
 ## Examples
 
     # Get single album by ID
-    client.get_album('53d0dcdc6c6f725407000000')
-    => {"id"=>"53d0dcdc6c6f725407000000", "title"=>"New album", "subtitle"=>"A subtitle", ...
+    client.get_albums(id: '77774dc8-4edf-4b3a-8571-a6b64c8adace')
+    => [#<Hotchoc::Presenters::Album: title="Test album 1">]
 
     # Get all albums
     client.get_albums
-    => [{"id"=>"53d0dcdc6c6f725407000000", "title"=>"New album", "subtitle"=>"A subtitle", ...
+    => [#<Hotchoc::Presenters::Album: title="Test album 2">, #<Hotchoc::Presenters::Album: title="Test album 1">]
 
     # Get only first 10 albums
     client.get_albums(limit: 10)
-    => [{"id"=>"53d0dcdc6c6f725407000000", "title"=>"New album", "subtitle"=>"A subtitle", ...
+    => [#<Hotchoc::Presenters::Album: title="Test album 2">, #<Hotchoc::Presenters::Album: title="Test album 1">]
 
 ## API
 
-### Get single resource
-
-    client.get_album(id)
-    client.get_page(id)
-    client.get_post(id)
-    client.get_topic(id)
-
 ### Get collection
 
     client.get_albums

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+desc 'Run RuboCop checks'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['{lib,spec}/**/*.rb']
+  task.formatters = ['progress']
+  task.fail_on_error = true
+end

data/hotchoc.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = Hotchoc::VERSION
   spec.authors       = ["Matthias Siegel"]
   spec.email         = ["matthias.siegel@gmail.com"]
-  spec.summary       = %q{Official Ruby wrapper for the Hotchoc API.}
-  spec.description   = %q{Official Ruby wrapper for the Hotchoc API.}
+  spec.summary       = %q{Ruby wrapper for the Hotchoc API.}
+  spec.description   = %q{Ruby wrapper for the Hotchoc API.}
   spec.homepage      = "https://github.com/choc/hotchoc-ruby"
   spec.license       = "MIT"
 
@@ -16,10 +16,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "typhoeus", "~> 0.6.9"
+  spec.add_dependency "typhoeus", "~> 0.7.0"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 1.18"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rubocop", "~> 0.24.1"
+  spec.add_development_dependency "webmock", "~> 1.20"
 end