apple-news 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49d7dc6cf8af8b5a5d8cbe1506c726ab8b7f2f6c
-  data.tar.gz: bc7c9403b332703d6c31f97804b869d83a39b298
+  metadata.gz: 7d6c403146c04a7a93ffe92adaa573a15dd9d551
+  data.tar.gz: 6f82b260da85c323757389ad47d83b843c8967e5
 SHA512:
-  metadata.gz: 35fd32d286a50ce9e9f851d18f46f834ff63c0c5a5f3d8b5f0fd74581bdf22e27147671603b95e73a86fcc53e8ac1f9b7517c657e4d2608991bcc92eb39248a6
-  data.tar.gz: 77d4cda118ab87d06efe10dd53f4ebcd8a9f76bbab34bda133afb627d1705c558cac62efaf9da7a2d2d19cc4ba473d50f22e7fa394ab0f441cd3342751d26007
+  metadata.gz: 1224e897e5dac6d57e17f6c1a022efa778e530f7bd3d794468a4af8453ec590134c6e17aa266da9f596bf263b92ea3916ccacedb0de44f508dd4b39075d38b08
+  data.tar.gz: 3c2f340b35ad3448708f38800db080b341e2f16053618e8bf8c9b88abf9c46eed8845b79840ad29f2bea8cf5ee4218575e2ad1e7eafedd7bc7f153631dd202eb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 HODINKEE
+
+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

@@ -35,10 +35,19 @@ AppleNews.config.api_key_secret = "miJAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
 You can fetch the Channel information by calling:
 
 ``` ruby
-channel = AppleNews::Channel.current
+channel = AppleNews.config.channel
 ```
 
-Because each channel has a separate API key, there is only ever one channel that you can fetch.
+If working with multiple channels:
+
+```ruby
+config = AppleNews::Configuration.new(
+  channel_id:     '...',
+  api_key_id:     '...',
+  api_key_secret: '...'
+)
+channel = config.channel
+```
 
 ### Sections
 
@@ -48,7 +57,7 @@ You can either fetch sections by their ID, or by fetching all of them through th
 section = AppleNews::Section.new(section_id)
 
 # or
-channel = AppleNews::Channel.current
+channel = AppleNews.config.channel
 channel.default_section # for the default section
 channel.sections # for all the sections
 ```
@@ -61,11 +70,24 @@ You can fetch articles either by their ID, their channel, or their section.
 article = AppleNews::Article.new(article_id)
 
 # or
-channel = AppleNews::Channel.current
+channel = AppleNews.config.channel
 channel.articles # all articles in the channel
 channel.default_section.articles # all articles in the default section
 ```
 
+The 10 most recent articles are returned by default. To change the number or sort order, you can pass any of [the query params defined in the API docs](https://developer.apple.com/library/content/documentation/General/Conceptual/News_API_Ref/SearchArticles.html#//apple_ref/doc/uid/TP40015409-CH17-SW1). For example:
+
+``` ruby
+# first 5 articles
+channel.articles(sortDir: 'ASC', pageSize: 5)
+```
+
+A "Read Article" API request will be made for each article to ensure that `#document` exists (the search endpoint only returns read-only attributes). If you don't need to access the document, you can opt-out of this behavior via:
+
+``` ruby
+channel.articles(hydrate: false)
+```
+
 ## Submitting Articles
 
 Apple News articles are submitted as "bundles", with the article content and attached files together in one request. Because of this, we have the concept of a Document. The Document is what contains the actual article content in the Apple News JSON format. The Article encapsulates this and also includes all of the files that will be submitted along with the document.

data/lib/apple-news/article.rb

@@ -1,37 +1,30 @@
 require 'apple-news/article/attachments'
 require 'apple-news/article/persistence'
+require 'apple-news/document'
 
 module AppleNews
   class Article
-    extend Forwardable
-
     include Attachments
     include Persistence
     include Resource
     include Properties
 
-    optional_properties :is_sponsored, :is_preview, :accessory_text, :revision
+    optional_properties :is_sponsored, :is_preview, :accessory_text, :revision,
+                        :maturity_rating, :is_candidate_to_be_featured
     optional_property :links, {}
 
-    attr_reader :id, :share_url, :state
+    attr_reader :id, :type, :title, :share_url, :state, :warnings, :created_at, :modified_at
     attr_accessor :document
-    def_delegator :@document, :title
 
-    def initialize(id = nil, data = {})
-      super(data)
+    def initialize(id = nil, data = {}, config = AppleNews.config)
+      assign_data(data)
 
-      @resource_path = "/articles"
       @id = id
-
-      document = (data[:document] || data['document'])
-      @document = document.is_a?(AppleNews::Document) ? document : Document.new(document)
+      @config = config
+      @resource_path = '/articles'
       @files = {}
 
-      # These are read-only properties that are not submitted to the API
-      @share_url = data['shareUrl']
-      @state = data['state']
-
-      hydrate! if !id.nil? && data.keys.size == 0
+      hydrate! if id.present? && data.blank?
     end
 
     def reload
@@ -43,13 +36,17 @@ module AppleNews
 
     def hydrate!
       data = fetch_data['data']
-      
-      # Some special properties that need to be manually set.
-      @document = Document.new(data.delete('document'))
-      @share_url = data.delete('shareUrl')
-      @state = data.delete('state')
+      assign_data(data)
+    end
+
+    def assign_data(data)
+      data = data.with_indifferent_access
+      document = data.delete(:document)
 
+      set_read_only_properties(data)
       load_properties(data)
+
+      @document = document.is_a?(AppleNews::Document) ? document : Document.new(document)
     end
   end
 end

data/lib/apple-news/article/persistence.rb

@@ -5,7 +5,7 @@ module AppleNews
 
       included do
         def save!
-          request = Request::Post.new(endpoint_url)
+          request = Request::Post.new(endpoint_url, config)
           request.fields = {
             'metadata' => metadata_field,
             'article.json' => document_json
@@ -27,7 +27,7 @@ module AppleNews
         alias_method :saved?, :persisted?
 
         def delete!
-          request = Request::Delete.new(endpoint_url)
+          request = Request::Delete.new(endpoint_url, config)
           resp = request.call
 
           return resp['errors'] if resp.is_a?(Hash) && resp.has_key?('errors')
@@ -65,7 +65,7 @@ module AppleNews
           if persisted?
             "/articles/#{id}"
           else
-            "/channels/#{AppleNews.config.channel_id}/articles"
+            "/channels/#{config.channel_id}/articles"
           end
         end
 

data/lib/apple-news/channel.rb

@@ -7,33 +7,37 @@ module AppleNews
                 :default_section, :share_url
 
     def self.current
-      self.new(AppleNews.config.channel_id)
+      warn 'DEPRECATION WARNING: `AppleNews::Channel.current` is deprecated. '\
+           'Please use `AppleNews.config.channel` instead.'
+      AppleNews.config.channel
     end
 
-    def initialize(id, data = nil)
+    def initialize(id, data = nil, config = AppleNews.config)
       @id = id
-      @resource_path = "/channels"
+      @config = config
+      @resource_path = '/channels'
 
       data.nil? ? hydrate! : set_read_only_properties(data)
     end
 
     def default_section
-      Section.new(section_link_id('defaultSection'))
+      Section.new(section_link_id('defaultSection'), nil, config)
     end
 
     def sections
-      request = Request::Get.new("/channels/#{id}/sections")
-      resp = request.call
+      resp = get_request("/channels/#{id}/sections")
       resp['data'].map do |section|
-        Section.new(section['id'], section)
+        Section.new(section['id'], section, config)
       end
     end
 
     def articles(params = {})
-      request = Request::Get.new("/channels/#{id}/articles")
-      resp = request.call(params)
+      params  = params.with_indifferent_access
+      hydrate = params.delete(:hydrate)
+      resp = get_request("/channels/#{id}/articles", params)
       resp['data'].map do |article|
-        Article.new(article['id'])
+        data = hydrate == false ? article : {}
+        Article.new(article['id'], data, config)
       end
     end
   end

data/lib/apple-news/configuration.rb

@@ -1,12 +1,16 @@
 module AppleNews
   class Configuration
     attr_accessor :channel_id, :api_key_id, :api_key_secret, :api_base
-    
-    def initialize
-      @channel_id = nil
-      @api_key_id = nil
-      @api_key_secret = nil
-      @api_base = 'https://news-api.apple.com'
+
+    def initialize(attributes = {})
+      @channel_id     = attributes[:channel_id]
+      @api_key_id     = attributes[:api_key_id]
+      @api_key_secret = attributes[:api_key_secret]
+      @api_base       = attributes[:api_base] || 'https://news-api.apple.com'
+    end
+
+    def channel
+      AppleNews::Channel.new(channel_id, nil, self)
     end
   end
 end

data/lib/apple-news/properties.rb

@@ -9,8 +9,9 @@ module AppleNews
     def load_properties(opts)
       opts = ActiveSupport::HashWithIndifferentAccess.new(opts || {})
       self.class.properties.each do |prop, settings|
+        camelized_prop = prop.to_s.camelize(:lower)
         val = if !settings[:klass].nil?
-          assigned_val = opts.fetch(prop, settings[:default])
+          assigned_val = opts.fetch(camelized_prop, settings[:default])
 
           if settings[:default].is_a?(Array)
             assigned_val.map { |v|
@@ -26,7 +27,7 @@ module AppleNews
             assigned_val.nil? ? nil : settings[:klass].send(settings[:init_method], assigned_val)
           end
         else
-          opts.fetch(prop, settings[:default])
+          opts.fetch(camelized_prop, settings[:default])
         end
 
         instance_variable_set "@#{prop}", val

data/lib/apple-news/requests/delete.rb

@@ -3,8 +3,8 @@ module AppleNews
     class Delete
       attr_reader :url
 
-      def initialize(url)
-        @config = AppleNews.config
+      def initialize(url, config = AppleNews.config)
+        @config = config
         @url = URI::parse(File.join(@config.api_base, url))
       end
 
@@ -20,7 +20,7 @@ module AppleNews
       private
 
       def headers
-        security = AppleNews::Security.new('DELETE', @url.to_s)
+        security = AppleNews::Security.new('DELETE', @url.to_s, @config)
         { 'Authorization' => security.authorization }
       end
     end

data/lib/apple-news/requests/get.rb

@@ -3,8 +3,8 @@ module AppleNews
     class Get
       attr_reader :url
 
-      def initialize(url)
-        @config = AppleNews.config
+      def initialize(url, config = AppleNews.config)
+        @config = config
         @url = URI::parse(File.join(@config.api_base, url))
       end
 
@@ -20,7 +20,7 @@ module AppleNews
       private
 
       def headers
-        security = AppleNews::Security.new('GET', @url.to_s)
+        security = AppleNews::Security.new('GET', @url.to_s, @config)
         { 'Authorization' => security.authorization }
       end
     end

data/lib/apple-news/requests/post.rb

@@ -4,8 +4,8 @@ module AppleNews
       attr_reader :url
       attr_accessor :fields
 
-      def initialize(url)
-        @config = AppleNews.config
+      def initialize(url, config = AppleNews.config)
+        @config = config
         @url = URI::parse(File.join(@config.api_base, url))
         @fields = {}
       end
@@ -42,7 +42,7 @@ module AppleNews
       end
 
       def authorization
-        security = AppleNews::Security.new('POST', @url)
+        security = AppleNews::Security.new('POST', @url, @config)
         security.content_type = "multipart/form-data; boundary=#{Net::HTTP::Post::Multipart::DEFAULT_BOUNDARY}"
         security.content_body = content_body
 

data/lib/apple-news/resource.rb

@@ -3,6 +3,8 @@ module AppleNews
     extend ActiveSupport::Concern
 
     included do
+      attr_accessor :config
+
       def update_with_data(data)
         load_properties(data)
       end
@@ -11,6 +13,10 @@ module AppleNews
         File.join(@resource_path, id)
       end
 
+      def get_request(path, params = {})
+        AppleNews::Request::Get.new(path, config).call(params)
+      end
+
       private
 
       def hydrate!
@@ -22,13 +28,12 @@ module AppleNews
       end
 
       def fetch_data
-        request = AppleNews::Request::Get.new(resource_url)
-        request.call
+        get_request(resource_url)
       end
 
       def set_read_only_properties(data)
         data.each do |k, v|
-          instance_variable_set("@#{k.underscore}", v)
+          instance_variable_set("@#{k.to_s.underscore}", v)
         end
       end
     end

data/lib/apple-news/section.rb

@@ -5,22 +5,25 @@ module AppleNews
 
     attr_reader :id, :type, :name, :is_default, :links, :created_at, :modified_at, :share_url
 
-    def initialize(id, data = nil)
+    def initialize(id, data = nil, config = AppleNews.config)
       @id = id
-      @resource_path = "/sections"
+      @config = config
+      @resource_path = '/sections'
 
       data.nil? ? hydrate! : set_read_only_properties(data)
     end
 
     def channel
-      Channel.new(channel_link_id('channel'))
+      Channel.new(channel_link_id('channel'), nil, config)
     end
 
     def articles(params = {})
-      request = Request::Get.new("/sections/#{id}/articles")
-      resp = request.call(params)
+      params  = params.with_indifferent_access
+      hydrate = params.delete(:hydrate)
+      resp = get_request("/sections/#{id}/articles", params)
       resp['data'].map do |article|
-        Article.new(article['id'])
+        data = hydrate == false ? article : {}
+        Article.new(article['id'], data, config)
       end
     end
   end

data/lib/apple-news/security.rb

@@ -1,12 +1,14 @@
+require 'base64'
+require 'openssl'
+
 module AppleNews
   class Security
     attr_accessor :method, :url, :content_type, :content_body
 
-    def initialize(method, url)
-      @config = AppleNews.config
-
+    def initialize(method, url, config = AppleNews.config)
       @method = method.upcase
       @url = url
+      @config = config
       @date = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
       @content_type = nil
       @content_body = nil

data/lib/apple-news/version.rb

@@ -1,3 +1,3 @@
 module AppleNews
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple-news
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryan LeFevre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - apple-news.gemspec